NSQConfig

clientId: an identifier used to disambiguate this client (ie. something specific to the consumer)
hostname: the hostname where the client is deployed
userAgent: (nsqd v0.2.25+) a string identifying the agent for this client in the spirit of HTTP Default: <client_library_name>/<version>
featureNegotiation: (nsqd v0.2.19+) bool used to indicate that the client supports feature negotiation. If the server is capable, it will send back a JSON payload of supported features and metadata.
heartbeatInterval: (nsqd v0.2.19+) milliseconds between heartbeats. Valid range: 1000 <= heartbeat_interval <= configured_max (-1 disables heartbeats) --max-heartbeat-interval (nsqd flag) controls the max Defaults to --client-timeout / 2
outputBufferSize: (nsqd v0.2.21+) the size in bytes of the buffer nsqd will use when writing to this client. Valid range: 64 <= output_buffer_size <= configured_max (-1 disables output buffering) --max-output-buffer-size (nsqd flag) controls the max Defaults to 16kb
outputBufferTimeout: (nsqd v0.2.21+) the timeout after which any data that nsqd has buffered will be flushed to this client. Valid range: 1ms <= output_buffer_timeout <= configured_max (-1 disables timeouts) --max-output-buffer-timeout (nsqd flag) controls the max. Defaults to 250ms Warning: configuring clients with an extremely low (< 25ms) output_buffer_timeout has a significant effect on nsqd CPU usage (particularly with > 50 clients connected). This is due to the current implementation relying on Go timers which are maintained by the Go runtime in a priority queue. See the commit message in pull request #236 for more details.
tlsV1: (nsqd v0.2.22+) enable TLS for this connection. --tls-cert and --tls-key (nsqd flags) enable TLS and configure the server certificate If the server supports TLS it will reply "tls_v1": true The client should begin the TLS handshake immediately after reading the IDENTIFY response The server will respond OK after completing the TLS handshake
snappy: snappy (nsqd v0.2.23+) enable snappy compression for this connection. --snappy (nsqd flag) enables support for this server side
deflate: deflate (nsqd v0.2.23+) enable deflate compression for this connection. --deflate (nsqd flag) enables support for this server side The client should expect an additional, deflate compressed OK response immediately after the IDENTIFY response. A client cannot enable both snappy and deflate.
deflateLevel: (nsqd v0.2.23+) configure the deflate compression level for this connection. --max-deflate-level (nsqd flag) configures the maximum allowed value Valid range: 1 <= deflate_level <= configured_max Higher values mean better compression but more CPU usage for nsqd.
sampleRate: (nsqd v0.2.25+) deliver a percentage of all messages received to this connection. Valid range: 0 <= sample_rate <= 99 (0 disables sampling) Defaults to 0
msgTimeout: (nsqd v0.2.28+) configure the server-side message timeout in milliseconds for messages delivered to this client.

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new NSQConfig(clientId: String, hostname: String, userAgent: String, featureNegotiation: Boolean = true, heartbeatInterval: Option[Int] = None, outputBufferSize: Option[Int] = None, outputBufferTimeout: Option[Long] = None, tlsV1: Option[Boolean] = None, snappy: Option[Boolean] = None, deflate: Option[Boolean] = None, deflateLevel: Option[Int] = None, sampleRate: Option[Int] = None, msgTimeout: Option[Long] = None)

clientId
an identifier used to disambiguate this client (ie. something specific to the consumer)
hostname
the hostname where the client is deployed
userAgent
(nsqd v0.2.25+) a string identifying the agent for this client in the spirit of HTTP Default: <client_library_name>/<version>
featureNegotiation
(nsqd v0.2.19+) bool used to indicate that the client supports feature negotiation. If the server is capable, it will send back a JSON payload of supported features and metadata.
heartbeatInterval
(nsqd v0.2.19+) milliseconds between heartbeats. Valid range: 1000 <= heartbeat_interval <= configured_max (-1 disables heartbeats) --max-heartbeat-interval (nsqd flag) controls the max Defaults to --client-timeout / 2
outputBufferSize
(nsqd v0.2.21+) the size in bytes of the buffer nsqd will use when writing to this client. Valid range: 64 <= output_buffer_size <= configured_max (-1 disables output buffering) --max-output-buffer-size (nsqd flag) controls the max Defaults to 16kb
outputBufferTimeout
(nsqd v0.2.21+) the timeout after which any data that nsqd has buffered will be flushed to this client. Valid range: 1ms <= output_buffer_timeout <= configured_max (-1 disables timeouts) --max-output-buffer-timeout (nsqd flag) controls the max. Defaults to 250ms Warning: configuring clients with an extremely low (< 25ms) output_buffer_timeout has a significant effect on nsqd CPU usage (particularly with > 50 clients connected). This is due to the current implementation relying on Go timers which are maintained by the Go runtime in a priority queue. See the commit message in pull request #236 for more details.
tlsV1
(nsqd v0.2.22+) enable TLS for this connection. --tls-cert and --tls-key (nsqd flags) enable TLS and configure the server certificate If the server supports TLS it will reply "tls_v1": true The client should begin the TLS handshake immediately after reading the IDENTIFY response The server will respond OK after completing the TLS handshake
snappy
snappy (nsqd v0.2.23+) enable snappy compression for this connection. --snappy (nsqd flag) enables support for this server side
deflate
deflate (nsqd v0.2.23+) enable deflate compression for this connection. --deflate (nsqd flag) enables support for this server side The client should expect an additional, deflate compressed OK response immediately after the IDENTIFY response. A client cannot enable both snappy and deflate.
deflateLevel
(nsqd v0.2.23+) configure the deflate compression level for this connection. --max-deflate-level (nsqd flag) configures the maximum allowed value Valid range: 1 <= deflate_level <= configured_max Higher values mean better compression but more CPU usage for nsqd.
sampleRate
(nsqd v0.2.25+) deliver a percentage of all messages received to this connection. Valid range: 0 <= sample_rate <= 99 (0 disables sampling) Defaults to 0
msgTimeout
(nsqd v0.2.28+) configure the server-side message timeout in milliseconds for messages delivered to this client.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def asJson(out: ByteBuf): ByteBuf
val clientId: String

an identifier used to disambiguate this client (ie.
an identifier used to disambiguate this client (ie. something specific to the consumer)
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val deflate: Option[Boolean]

deflate (nsqd v0.2.23+) enable deflate compression for this connection.
deflate (nsqd v0.2.23+) enable deflate compression for this connection. --deflate (nsqd flag) enables support for this server side The client should expect an additional, deflate compressed OK response immediately after the IDENTIFY response. A client cannot enable both snappy and deflate.
val deflateLevel: Option[Int]

(nsqd v0.2.23+) configure the deflate compression level for this connection.
(nsqd v0.2.23+) configure the deflate compression level for this connection. --max-deflate-level (nsqd flag) configures the maximum allowed value Valid range: 1 <= deflate_level <= configured_max Higher values mean better compression but more CPU usage for nsqd.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val featureNegotiation: Boolean

(nsqd v0.2.19+) bool used to indicate that the client supports feature negotiation.
(nsqd v0.2.19+) bool used to indicate that the client supports feature negotiation. If the server is capable, it will send back a JSON payload of supported features and metadata.
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
val heartbeatInterval: Option[Int]

(nsqd v0.2.19+) milliseconds between heartbeats.
(nsqd v0.2.19+) milliseconds between heartbeats. Valid range: 1000 <= heartbeat_interval <= configured_max (-1 disables heartbeats) --max-heartbeat-interval (nsqd flag) controls the max Defaults to --client-timeout / 2
val hostname: String

the hostname where the client is deployed
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val msgTimeout: Option[Long]

(nsqd v0.2.28+) configure the server-side message timeout in milliseconds for messages delivered to this client.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val outputBufferSize: Option[Int]

(nsqd v0.2.21+) the size in bytes of the buffer nsqd will use when writing to this client.
(nsqd v0.2.21+) the size in bytes of the buffer nsqd will use when writing to this client. Valid range: 64 <= output_buffer_size <= configured_max (-1 disables output buffering) --max-output-buffer-size (nsqd flag) controls the max Defaults to 16kb
val outputBufferTimeout: Option[Long]

(nsqd v0.2.21+) the timeout after which any data that nsqd has buffered will be flushed to this client.
(nsqd v0.2.21+) the timeout after which any data that nsqd has buffered will be flushed to this client. Valid range: 1ms <= output_buffer_timeout <= configured_max (-1 disables timeouts) --max-output-buffer-timeout (nsqd flag) controls the max. Defaults to 250ms Warning: configuring clients with an extremely low (< 25ms) output_buffer_timeout has a significant effect on nsqd CPU usage (particularly with > 50 clients connected). This is due to the current implementation relying on Go timers which are maintained by the Go runtime in a priority queue. See the commit message in pull request #236 for more details.
val sampleRate: Option[Int]

(nsqd v0.2.25+) deliver a percentage of all messages received to this connection.
(nsqd v0.2.25+) deliver a percentage of all messages received to this connection. Valid range: 0 <= sample_rate <= 99 (0 disables sampling) Defaults to 0
val snappy: Option[Boolean]

snappy (nsqd v0.2.23+) enable snappy compression for this connection.
snappy (nsqd v0.2.23+) enable snappy compression for this connection. --snappy (nsqd flag) enables support for this server side
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val tlsV1: Option[Boolean]

(nsqd v0.2.22+) enable TLS for this connection.
(nsqd v0.2.22+) enable TLS for this connection. --tls-cert and --tls-key (nsqd flags) enable TLS and configure the server certificate If the server supports TLS it will reply "tls_v1": true The client should begin the TLS handshake immediately after reading the IDENTIFY response The server will respond OK after completing the TLS handshake
val userAgent: String

(nsqd v0.2.25+) a string identifying the agent for this client in the spirit of HTTP Default: <client_library_name>/<version>
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package protocol

Instance Constructors

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def asJson(out: ByteBuf): ByteBuf

val clientId: String

def clone(): AnyRef

val deflate: Option[Boolean]

val deflateLevel: Option[Int]

final def eq(arg0: AnyRef): Boolean

val featureNegotiation: Boolean

def finalize(): Unit

final def getClass(): Class[_]

val heartbeatInterval: Option[Int]

val hostname: String

final def isInstanceOf[T0]: Boolean

val msgTimeout: Option[Long]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val outputBufferSize: Option[Int]

val outputBufferTimeout: Option[Long]

val sampleRate: Option[Int]

val snappy: Option[Boolean]

final def synchronized[T0](arg0: ⇒ T0): T0

val tlsV1: Option[Boolean]

val userAgent: String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped