Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ConsulClientOptions

Options used to create Consul client.

Hierarchy

  • any
    • ConsulClientOptions

Index

Constructors

Methods

Constructors

constructor

Methods

addCrlPath

  • Add a CRL path

    Parameters

    • crlPaths: string

    Returns ConsulClientOptions

addCrlValue

  • Add a CRL value

    Parameters

    • crlValues: Buffer

    Returns ConsulClientOptions

addEnabledCipherSuite

  • Add an enabled cipher suite, appended to the ordered suites.

    Parameters

    • enabledCipherSuites: string

    Returns ConsulClientOptions

addEnabledSecureTransportProtocol

  • addEnabledSecureTransportProtocol(enabledSecureTransportProtocols: string): ConsulClientOptions
  • Add an enabled SSL/TLS protocols, appended to the ordered protocols.

    Parameters

    • enabledSecureTransportProtocols: string

    Returns ConsulClientOptions

addNonProxyHost

  • Parameters

    • nonProxyHosts: string

    Returns ConsulClientOptions

getAclToken

  • getAclToken(): string
  • Set the ACL token. When provided, the client will use this token when making requests to the Consul by providing the "?token" query parameter. When not provided, the empty token, which maps to the 'anonymous' ACL policy, is used.

    Returns string

getActivityLogDataFormat

  • getActivityLogDataFormat(): any
  • Returns any

getAlpnVersions

  • getAlpnVersions(): HttpVersion[]
  • Set the list of protocol versions to provide to the server during the Application-Layer Protocol Negotiation. When the list is empty, the client provides a best effort list according to ConsulClientOptions:

    Returns HttpVersion[]

getConnectTimeout

  • getConnectTimeout(): number
  • Set the connect timeout

    Returns number

getCrlPaths

  • getCrlPaths(): string[]
  • Add a CRL path

    Returns string[]

getCrlValues

  • getCrlValues(): Buffer[]
  • Add a CRL value

    Returns Buffer[]

getDc

  • getDc(): string
  • Set the datacenter name. When provided, the client will use it when making requests to the Consul by providing the "?dc" query parameter. When not provided, the datacenter of the consul agent is queried.

    Returns string

getDecoderInitialBufferSize

  • getDecoderInitialBufferSize(): number
  • set to initialBufferSizeHttpDecoder the initial buffer of the HttpDecoder.

    Returns number

getDefaultHost

  • getDefaultHost(): string
  • Set the default host name to be used by this client in requests if none is provided when making the request.

    Returns string

getDefaultPort

  • getDefaultPort(): number
  • Set the default port to be used by this client in requests if none is provided when making the request.

    Returns number

getEnabledCipherSuites

  • getEnabledCipherSuites(): string[]
  • Add an enabled cipher suite, appended to the ordered suites.

    Returns string[]

getEnabledSecureTransportProtocols

  • getEnabledSecureTransportProtocols(): string[]
  • Add an enabled SSL/TLS protocols, appended to the ordered protocols.

    Returns string[]

getHttp2ConnectionWindowSize

  • getHttp2ConnectionWindowSize(): number
  • Set the default HTTP/2 connection window size. It overrides the initial window size set by , so the connection window size is greater than for its streams, in order the data throughput.

    A value of -1 reuses the initial window size setting.

    Returns number

getHttp2KeepAliveTimeout

  • getHttp2KeepAliveTimeout(): number
  • Returns number

getHttp2MaxPoolSize

  • getHttp2MaxPoolSize(): number
  • Set the maximum pool size for HTTP/2 connections

    Returns number

getHttp2MultiplexingLimit

  • getHttp2MultiplexingLimit(): number
  • Set a client limit of the number concurrent streams for each HTTP/2 connection, this limits the number of streams the client can create for a connection. The effective number of streams for a connection is the min of this value and the server's initial settings.

    Setting the value to -1 means to use the value sent by the server's initial settings. -1 is the default value.

    Returns number

getIdleTimeout

  • getIdleTimeout(): number
  • Set the idle timeout, in seconds. zero means don't timeout. This determines if a connection will timeout and be closed if no data is received within the timeout.

    Returns number

getIdleTimeoutUnit

  • getIdleTimeoutUnit(): any
  • Set the idle timeout unit. If not specified, default is seconds.

    Returns any

getInitialSettings

  • getInitialSettings(): Http2Settings
  • Set the HTTP/2 connection settings immediately sent by to the server when the client connects.

    Returns Http2Settings

getJdkSslEngineOptions

  • getJdkSslEngineOptions(): JdkSSLEngineOptions
  • Returns JdkSSLEngineOptions

getKeepAliveTimeout

  • getKeepAliveTimeout(): number
  • Returns number

getKeyStoreOptions

  • getKeyStoreOptions(): JksOptions
  • Set the key/cert options in jks format, aka Java keystore.

    Returns JksOptions

getLocalAddress

  • getLocalAddress(): string
  • Set the local interface to bind for network connections. When the local address is null, it will pick any local address, the default local address is null.

    Returns string

getLogActivity

  • getLogActivity(): boolean
  • Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.

    Returns boolean

getMaxChunkSize

  • getMaxChunkSize(): number
  • Set the maximum HTTP chunk size

    Returns number

getMaxHeaderSize

  • getMaxHeaderSize(): number
  • Set the maximum length of all headers for HTTP/1.x .

    Returns number

getMaxInitialLineLength

  • getMaxInitialLineLength(): number
  • Set the maximum length of the initial line for HTTP/1.x (e.g. "HTTP/1.1 200 OK")

    Returns number

getMaxPoolSize

  • getMaxPoolSize(): number
  • Set the maximum pool size for connections

    Returns number

getMaxRedirects

  • getMaxRedirects(): number
  • Set to maxRedirects the maximum number of redirection a request can follow.

    Returns number

getMaxWaitQueueSize

  • getMaxWaitQueueSize(): number
  • Set the maximum requests allowed in the wait queue, any requests beyond the max size will result in a ConnectionPoolTooBusyException. If the value is set to a negative number then the queue will be unbounded.

    Returns number

getMaxWebSocketFrameSize

  • getMaxWebSocketFrameSize(): number
  • Set the max websocket frame size

    Returns number

getMaxWebSocketMessageSize

  • getMaxWebSocketMessageSize(): number
  • Set the max websocket message size

    Returns number

getMaxWebSockets

  • getMaxWebSockets(): number
  • Returns number

getMetricsName

  • getMetricsName(): string
  • Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name.

    Returns string

getName

  • getName(): string
  • Returns string

getNonProxyHosts

  • getNonProxyHosts(): string[]
  • Returns string[]

getOpenSslEngineOptions

  • getOpenSslEngineOptions(): OpenSSLEngineOptions
  • Returns OpenSSLEngineOptions

getPemKeyCertOptions

  • getPemKeyCertOptions(): PemKeyCertOptions
  • Set the key/cert store options in pem format.

    Returns PemKeyCertOptions

getPemTrustOptions

  • getPemTrustOptions(): PemTrustOptions
  • Set the trust options.

    Returns PemTrustOptions

getPfxKeyCertOptions

  • getPfxKeyCertOptions(): PfxOptions
  • Set the key/cert options in pfx format.

    Returns PfxOptions

getPfxTrustOptions

  • getPfxTrustOptions(): PfxOptions
  • Set the trust options in pfx format

    Returns PfxOptions

getPipeliningLimit

  • getPipeliningLimit(): number
  • Set the limit of pending requests a pipe-lined HTTP/1 connection can send.

    Returns number

getPoolCleanerPeriod

  • getPoolCleanerPeriod(): number
  • Returns number

getPoolEventLoopSize

  • getPoolEventLoopSize(): number
  • Returns number

getProtocolVersion

  • getProtocolVersion(): HttpVersion
  • Set the protocol version.

    Returns HttpVersion

getProxyOptions

  • getProxyOptions(): ProxyOptions
  • Set proxy options for connections via CONNECT proxy (e.g. Squid) or a SOCKS proxy.

    Returns ProxyOptions

getReadIdleTimeout

  • getReadIdleTimeout(): number
  • Returns number

getReceiveBufferSize

  • getReceiveBufferSize(): number
  • Set the TCP receive buffer size

    Returns number

getSendBufferSize

  • getSendBufferSize(): number
  • Set the TCP send buffer size

    Returns number

getSoLinger

  • getSoLinger(): number
  • Set whether SO_linger keep alive is enabled

    Returns number

getSslEngineOptions

  • getSslEngineOptions(): any
  • Set to use SSL engine implementation to use.

    Returns any

getSslHandshakeTimeout

  • getSslHandshakeTimeout(): number
  • Returns number

getSslHandshakeTimeoutUnit

  • getSslHandshakeTimeoutUnit(): any
  • Returns any

getTcpUserTimeout

  • getTcpUserTimeout(): number
  • Returns number

getTemplateExpandOptions

  • getTemplateExpandOptions(): ExpandOptions
  • Returns ExpandOptions

getTimeout

  • getTimeout(): number
  • Sets the amount of time (in milliseconds) after which if the request does not return any data within the timeout period an failure will be passed to the handler and the request will be closed.

    Returns number

getTracingPolicy

  • getTracingPolicy(): TracingPolicy
  • Returns TracingPolicy

getTrafficClass

  • getTrafficClass(): number
  • Set the value of traffic class

    Returns number

getTrustOptions

  • getTrustOptions(): any
  • Set the trust options.

    Returns any

getTrustStoreOptions

  • getTrustStoreOptions(): JksOptions
  • Set the trust options in jks format, aka Java truststore

    Returns JksOptions

getTryUsePerMessageWebSocketCompression

  • getTryUsePerMessageWebSocketCompression(): boolean
  • Returns boolean

getTryWebSocketDeflateFrameCompression

  • getTryWebSocketDeflateFrameCompression(): boolean
  • Returns boolean

getUserAgent

  • getUserAgent(): string
  • Sets the Web Client user agent header. Defaults to Vert.x-WebClient/<version>.

    Returns string

getWebSocketClosingTimeout

  • getWebSocketClosingTimeout(): number
  • Returns number

getWebSocketCompressionAllowClientNoContext

  • getWebSocketCompressionAllowClientNoContext(): boolean
  • Returns boolean

getWebSocketCompressionLevel

  • getWebSocketCompressionLevel(): number
  • Returns number

getWebSocketCompressionRequestServerNoContext

  • getWebSocketCompressionRequestServerNoContext(): boolean
  • Returns boolean

getWriteIdleTimeout

  • getWriteIdleTimeout(): number
  • Returns number

isFollowRedirects

  • isFollowRedirects(): boolean
  • Configure the default behavior of the client to follow HTTP 30x redirections.

    Returns boolean

isForceSni

  • isForceSni(): boolean
  • By default, the server name is only sent for Fully Qualified Domain Name (FQDN), setting this property to true forces the server name to be always sent.

    Returns boolean

isHttp2ClearTextUpgrade

  • isHttp2ClearTextUpgrade(): boolean
  • Set to true when an h2c connection is established using an HTTP/1.1 upgrade request, and false when an h2c connection is established directly (with prior knowledge).

    Returns boolean

isHttp2ClearTextUpgradeWithPreflightRequest

  • isHttp2ClearTextUpgradeWithPreflightRequest(): boolean
  • Returns boolean

isKeepAlive

  • isKeepAlive(): boolean
  • Set whether keep alive is enabled on the client

    Returns boolean

isPipelining

  • isPipelining(): boolean
  • Set whether pipe-lining is enabled on the client

    Returns boolean

isReuseAddress

  • isReuseAddress(): boolean
  • Set the value of reuse address

    Returns boolean

isReusePort

  • isReusePort(): boolean
  • Set the value of reuse port.

    This is only supported by native transports.

    Returns boolean

isSendUnmaskedFrames

  • isSendUnmaskedFrames(): boolean
  • Set true when the client wants to skip frame masking. You may want to set it true on server by server websocket communication: In this case you are by passing RFC6455 protocol. It's false as default.

    Returns boolean

isShared

  • isShared(): boolean
  • Returns boolean

isSsl

  • isSsl(): boolean
  • Set whether SSL/TLS is enabled

    Returns boolean

isTcpCork

  • isTcpCork(): boolean
  • Enable the TCP_CORK option - only with linux native transport.

    Returns boolean

isTcpFastOpen

  • isTcpFastOpen(): boolean
  • Enable the TCP_FASTOPEN option - only with linux native transport.

    Returns boolean

isTcpKeepAlive

  • isTcpKeepAlive(): boolean
  • Set whether TCP keep alive is enabled

    Returns boolean

isTcpNoDelay

  • isTcpNoDelay(): boolean
  • Set whether TCP no delay is enabled

    Returns boolean

isTcpQuickAck

  • isTcpQuickAck(): boolean
  • Enable the TCP_QUICKACK option - only with linux native transport.

    Returns boolean

isTrustAll

  • isTrustAll(): boolean
  • Set whether all server certificates should be trusted

    Returns boolean

isTryUseCompression

  • isTryUseCompression(): boolean
  • Set whether compression is enabled

    Returns boolean

isUseAlpn

  • isUseAlpn(): boolean
  • Set the ALPN usage.

    Returns boolean

isUserAgentEnabled

  • isUserAgentEnabled(): boolean
  • Sets whether the Web Client should send a user agent header. Defaults to true.

    Returns boolean

isVerifyHost

  • isVerifyHost(): boolean
  • Set whether hostname verification is enabled

    Returns boolean

setAclToken

  • Set the ACL token. When provided, the client will use this token when making requests to the Consul by providing the "?token" query parameter. When not provided, the empty token, which maps to the 'anonymous' ACL policy, is used.

    Parameters

    • aclToken: string

    Returns ConsulClientOptions

setActivityLogDataFormat

  • Parameters

    • activityLogDataFormat: any

    Returns ConsulClientOptions

setAlpnVersions

  • Set the list of protocol versions to provide to the server during the Application-Layer Protocol Negotiation. When the list is empty, the client provides a best effort list according to ConsulClientOptions:

    Parameters

    • alpnVersions: HttpVersion[]

    Returns ConsulClientOptions

setConnectTimeout

  • Set the connect timeout

    Parameters

    • connectTimeout: number

    Returns ConsulClientOptions

setDc

  • Set the datacenter name. When provided, the client will use it when making requests to the Consul by providing the "?dc" query parameter. When not provided, the datacenter of the consul agent is queried.

    Parameters

    • dc: string

    Returns ConsulClientOptions

setDecoderInitialBufferSize

  • set to initialBufferSizeHttpDecoder the initial buffer of the HttpDecoder.

    Parameters

    • decoderInitialBufferSize: number

    Returns ConsulClientOptions

setDefaultHost

  • Set the default host name to be used by this client in requests if none is provided when making the request.

    Parameters

    • defaultHost: string

    Returns ConsulClientOptions

setDefaultPort

  • Set the default port to be used by this client in requests if none is provided when making the request.

    Parameters

    • defaultPort: number

    Returns ConsulClientOptions

setEnabledSecureTransportProtocols

  • setEnabledSecureTransportProtocols(enabledSecureTransportProtocols: string[]): ConsulClientOptions
  • Add an enabled SSL/TLS protocols, appended to the ordered protocols.

    Parameters

    • enabledSecureTransportProtocols: string[]

    Returns ConsulClientOptions

setFollowRedirects

  • Configure the default behavior of the client to follow HTTP 30x redirections.

    Parameters

    • followRedirects: boolean

    Returns ConsulClientOptions

setForceSni

  • By default, the server name is only sent for Fully Qualified Domain Name (FQDN), setting this property to true forces the server name to be always sent.

    Parameters

    • forceSni: boolean

    Returns ConsulClientOptions

setHttp2ClearTextUpgrade

  • Set to true when an h2c connection is established using an HTTP/1.1 upgrade request, and false when an h2c connection is established directly (with prior knowledge).

    Parameters

    • http2ClearTextUpgrade: boolean

    Returns ConsulClientOptions

setHttp2ClearTextUpgradeWithPreflightRequest

  • setHttp2ClearTextUpgradeWithPreflightRequest(http2ClearTextUpgradeWithPreflightRequest: boolean): ConsulClientOptions
  • Parameters

    • http2ClearTextUpgradeWithPreflightRequest: boolean

    Returns ConsulClientOptions

setHttp2ConnectionWindowSize

  • Set the default HTTP/2 connection window size. It overrides the initial window size set by , so the connection window size is greater than for its streams, in order the data throughput.

    A value of -1 reuses the initial window size setting.

    Parameters

    • http2ConnectionWindowSize: number

    Returns ConsulClientOptions

setHttp2KeepAliveTimeout

  • Parameters

    • http2KeepAliveTimeout: number

    Returns ConsulClientOptions

setHttp2MaxPoolSize

  • Set the maximum pool size for HTTP/2 connections

    Parameters

    • http2MaxPoolSize: number

    Returns ConsulClientOptions

setHttp2MultiplexingLimit

  • Set a client limit of the number concurrent streams for each HTTP/2 connection, this limits the number of streams the client can create for a connection. The effective number of streams for a connection is the min of this value and the server's initial settings.

    Setting the value to -1 means to use the value sent by the server's initial settings. -1 is the default value.

    Parameters

    • http2MultiplexingLimit: number

    Returns ConsulClientOptions

setIdleTimeout

  • Set the idle timeout, in seconds. zero means don't timeout. This determines if a connection will timeout and be closed if no data is received within the timeout.

    Parameters

    • idleTimeout: number

    Returns ConsulClientOptions

setIdleTimeoutUnit

  • Set the idle timeout unit. If not specified, default is seconds.

    Parameters

    • idleTimeoutUnit: any

    Returns ConsulClientOptions

setInitialSettings

  • Set the HTTP/2 connection settings immediately sent by to the server when the client connects.

    Parameters

    • initialSettings: Http2Settings

    Returns ConsulClientOptions

setJdkSslEngineOptions

  • Parameters

    • jdkSslEngineOptions: JdkSSLEngineOptions

    Returns ConsulClientOptions

setKeepAlive

  • Set whether keep alive is enabled on the client

    Parameters

    • keepAlive: boolean

    Returns ConsulClientOptions

setKeepAliveTimeout

  • Parameters

    • keepAliveTimeout: number

    Returns ConsulClientOptions

setKeyCertOptions

  • Set the key/cert options.

    Parameters

    • keyCertOptions: any

    Returns ConsulClientOptions

setKeyStoreOptions

  • Set the key/cert options in jks format, aka Java keystore.

    Parameters

    • keyStoreOptions: JksOptions

    Returns ConsulClientOptions

setLocalAddress

  • Set the local interface to bind for network connections. When the local address is null, it will pick any local address, the default local address is null.

    Parameters

    • localAddress: string

    Returns ConsulClientOptions

setLogActivity

  • Set to true to enabled network activity logging: Netty's pipeline is configured for logging on Netty's logger.

    Parameters

    • logActivity: boolean

    Returns ConsulClientOptions

setMaxChunkSize

  • Set the maximum HTTP chunk size

    Parameters

    • maxChunkSize: number

    Returns ConsulClientOptions

setMaxHeaderSize

  • Set the maximum length of all headers for HTTP/1.x .

    Parameters

    • maxHeaderSize: number

    Returns ConsulClientOptions

setMaxInitialLineLength

  • Set the maximum length of the initial line for HTTP/1.x (e.g. "HTTP/1.1 200 OK")

    Parameters

    • maxInitialLineLength: number

    Returns ConsulClientOptions

setMaxPoolSize

  • Set the maximum pool size for connections

    Parameters

    • maxPoolSize: number

    Returns ConsulClientOptions

setMaxRedirects

  • Set to maxRedirects the maximum number of redirection a request can follow.

    Parameters

    • maxRedirects: number

    Returns ConsulClientOptions

setMaxWaitQueueSize

  • Set the maximum requests allowed in the wait queue, any requests beyond the max size will result in a ConnectionPoolTooBusyException. If the value is set to a negative number then the queue will be unbounded.

    Parameters

    • maxWaitQueueSize: number

    Returns ConsulClientOptions

setMaxWebSocketFrameSize

  • Set the max websocket frame size

    Parameters

    • maxWebSocketFrameSize: number

    Returns ConsulClientOptions

setMaxWebSocketMessageSize

  • Set the max websocket message size

    Parameters

    • maxWebSocketMessageSize: number

    Returns ConsulClientOptions

setMaxWebSockets

  • Parameters

    • maxWebSockets: number

    Returns ConsulClientOptions

setMetricsName

  • Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name.

    Parameters

    • metricsName: string

    Returns ConsulClientOptions

setName

  • Parameters

    • name: string

    Returns ConsulClientOptions

setNonProxyHosts

  • Parameters

    • nonProxyHosts: string[]

    Returns ConsulClientOptions

setOpenSslEngineOptions

  • Parameters

    • openSslEngineOptions: OpenSSLEngineOptions

    Returns ConsulClientOptions

setPemKeyCertOptions

  • Set the key/cert store options in pem format.

    Parameters

    • pemKeyCertOptions: PemKeyCertOptions

    Returns ConsulClientOptions

setPemTrustOptions

  • Set the trust options.

    Parameters

    • pemTrustOptions: PemTrustOptions

    Returns ConsulClientOptions

setPfxKeyCertOptions

  • Set the key/cert options in pfx format.

    Parameters

    • pfxKeyCertOptions: PfxOptions

    Returns ConsulClientOptions

setPfxTrustOptions

  • Set the trust options in pfx format

    Parameters

    • pfxTrustOptions: PfxOptions

    Returns ConsulClientOptions

setPipelining

  • Set whether pipe-lining is enabled on the client

    Parameters

    • pipelining: boolean

    Returns ConsulClientOptions

setPipeliningLimit

  • Set the limit of pending requests a pipe-lined HTTP/1 connection can send.

    Parameters

    • pipeliningLimit: number

    Returns ConsulClientOptions

setPoolCleanerPeriod

  • Parameters

    • poolCleanerPeriod: number

    Returns ConsulClientOptions

setPoolEventLoopSize

  • Parameters

    • poolEventLoopSize: number

    Returns ConsulClientOptions

setProtocolVersion

  • Set the protocol version.

    Parameters

    • protocolVersion: HttpVersion

    Returns ConsulClientOptions

setProxyOptions

  • Set proxy options for connections via CONNECT proxy (e.g. Squid) or a SOCKS proxy.

    Parameters

    • proxyOptions: ProxyOptions

    Returns ConsulClientOptions

setReadIdleTimeout

  • Parameters

    • readIdleTimeout: number

    Returns ConsulClientOptions

setReceiveBufferSize

  • Set the TCP receive buffer size

    Parameters

    • receiveBufferSize: number

    Returns ConsulClientOptions

setReuseAddress

  • Set the value of reuse address

    Parameters

    • reuseAddress: boolean

    Returns ConsulClientOptions

setReusePort

  • Set the value of reuse port.

    This is only supported by native transports.

    Parameters

    • reusePort: boolean

    Returns ConsulClientOptions

setSendBufferSize

  • Set the TCP send buffer size

    Parameters

    • sendBufferSize: number

    Returns ConsulClientOptions

setSendUnmaskedFrames

  • Set true when the client wants to skip frame masking. You may want to set it true on server by server websocket communication: In this case you are by passing RFC6455 protocol. It's false as default.

    Parameters

    • sendUnmaskedFrames: boolean

    Returns ConsulClientOptions

setShared

  • Parameters

    • shared: boolean

    Returns ConsulClientOptions

setSoLinger

  • Set whether SO_linger keep alive is enabled

    Parameters

    • soLinger: number

    Returns ConsulClientOptions

setSsl

  • Set whether SSL/TLS is enabled

    Parameters

    • ssl: boolean

    Returns ConsulClientOptions

setSslEngineOptions

  • Set to use SSL engine implementation to use.

    Parameters

    • sslEngineOptions: any

    Returns ConsulClientOptions

setSslHandshakeTimeout

  • Parameters

    • sslHandshakeTimeout: number

    Returns ConsulClientOptions

setSslHandshakeTimeoutUnit

  • Parameters

    • sslHandshakeTimeoutUnit: any

    Returns ConsulClientOptions

setTcpCork

  • Enable the TCP_CORK option - only with linux native transport.

    Parameters

    • tcpCork: boolean

    Returns ConsulClientOptions

setTcpFastOpen

  • Enable the TCP_FASTOPEN option - only with linux native transport.

    Parameters

    • tcpFastOpen: boolean

    Returns ConsulClientOptions

setTcpKeepAlive

  • Set whether TCP keep alive is enabled

    Parameters

    • tcpKeepAlive: boolean

    Returns ConsulClientOptions

setTcpNoDelay

  • Set whether TCP no delay is enabled

    Parameters

    • tcpNoDelay: boolean

    Returns ConsulClientOptions

setTcpQuickAck

  • Enable the TCP_QUICKACK option - only with linux native transport.

    Parameters

    • tcpQuickAck: boolean

    Returns ConsulClientOptions

setTcpUserTimeout

  • Parameters

    • tcpUserTimeout: number

    Returns ConsulClientOptions

setTemplateExpandOptions

  • Parameters

    • templateExpandOptions: ExpandOptions

    Returns ConsulClientOptions

setTimeout

  • Sets the amount of time (in milliseconds) after which if the request does not return any data within the timeout period an failure will be passed to the handler and the request will be closed.

    Parameters

    • timeout: number

    Returns ConsulClientOptions

setTracingPolicy

  • Parameters

    • tracingPolicy: TracingPolicy

    Returns ConsulClientOptions

setTrafficClass

  • Set the value of traffic class

    Parameters

    • trafficClass: number

    Returns ConsulClientOptions

setTrustAll

  • Set whether all server certificates should be trusted

    Parameters

    • trustAll: boolean

    Returns ConsulClientOptions

setTrustOptions

  • Set the trust options.

    Parameters

    • trustOptions: any

    Returns ConsulClientOptions

setTrustStoreOptions

  • Set the trust options in jks format, aka Java truststore

    Parameters

    • trustStoreOptions: JksOptions

    Returns ConsulClientOptions

setTryUseCompression

  • Set whether compression is enabled

    Parameters

    • tryUseCompression: boolean

    Returns ConsulClientOptions

setTryUsePerFrameWebSocketCompression

  • setTryUsePerFrameWebSocketCompression(tryUsePerFrameWebSocketCompression: boolean): ConsulClientOptions
  • Parameters

    • tryUsePerFrameWebSocketCompression: boolean

    Returns ConsulClientOptions

setTryUsePerMessageWebSocketCompression

  • setTryUsePerMessageWebSocketCompression(tryUsePerMessageWebSocketCompression: boolean): ConsulClientOptions
  • Parameters

    • tryUsePerMessageWebSocketCompression: boolean

    Returns ConsulClientOptions

setUseAlpn

  • Set the ALPN usage.

    Parameters

    • useAlpn: boolean

    Returns ConsulClientOptions

setUserAgent

  • Sets the Web Client user agent header. Defaults to Vert.x-WebClient/<version>.

    Parameters

    • userAgent: string

    Returns ConsulClientOptions

setUserAgentEnabled

  • Sets whether the Web Client should send a user agent header. Defaults to true.

    Parameters

    • userAgentEnabled: boolean

    Returns ConsulClientOptions

setVerifyHost

  • Set whether hostname verification is enabled

    Parameters

    • verifyHost: boolean

    Returns ConsulClientOptions

setWebSocketClosingTimeout

  • Parameters

    • webSocketClosingTimeout: number

    Returns ConsulClientOptions

setWebSocketCompressionAllowClientNoContext

  • setWebSocketCompressionAllowClientNoContext(webSocketCompressionAllowClientNoContext: boolean): ConsulClientOptions
  • Parameters

    • webSocketCompressionAllowClientNoContext: boolean

    Returns ConsulClientOptions

setWebSocketCompressionLevel

  • Parameters

    • webSocketCompressionLevel: number

    Returns ConsulClientOptions

setWebSocketCompressionRequestServerNoContext

  • setWebSocketCompressionRequestServerNoContext(webSocketCompressionRequestServerNoContext: boolean): ConsulClientOptions
  • Parameters

    • webSocketCompressionRequestServerNoContext: boolean

    Returns ConsulClientOptions

setWriteIdleTimeout

  • Parameters

    • writeIdleTimeout: number

    Returns ConsulClientOptions

toJson

  • toJson(): {}
  • Returns {}

    • [key: string]: any

Generated using TypeDoc