Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ClientOptionsBase

Base class for Client options

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

addCrlPath

addCrlValue

addEnabledCipherSuite

addEnabledSecureTransportProtocol

  • addEnabledSecureTransportProtocol(enabledSecureTransportProtocols: string): ClientOptionsBase

addNonProxyHost

  • Set a list of remote hosts that are not proxied when the client is configured to use a proxy. This list serves the same purpose than the JVM nonProxyHosts configuration.

    Entries can use the * wildcard character for pattern matching, e.g *.example.com matches www.example.com.

    Parameters

    • nonProxyHosts: string

    Returns ClientOptionsBase

getActivityLogDataFormat

  • getActivityLogDataFormat(): any
  • Set the value of Netty's logging handler's data format: Netty's pipeline is configured for logging on Netty's logger.

    Returns any

getConnectTimeout

  • getConnectTimeout(): number
  • Set the connect timeout

    Returns number

getCrlPaths

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

    Returns string[]

getCrlValues

getEnabledCipherSuites

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

    Returns string[]

getEnabledSecureTransportProtocols

  • getEnabledSecureTransportProtocols(): string[]

getIdleTimeout

  • getIdleTimeout(): number
  • Set the idle timeout, default time unit is seconds. Zero means don't timeout. This determines if a connection will timeout and be closed if no data is received nor sent within the timeout.

    If you want change default time unit, use ClientOptionsBase

    Returns number

getIdleTimeoutUnit

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

    Returns any

getJdkSslEngineOptions

getKeyStoreOptions

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

getMetricsName

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

    Returns string

getNonProxyHosts

  • getNonProxyHosts(): string[]
  • Set a list of remote hosts that are not proxied when the client is configured to use a proxy. This list serves the same purpose than the JVM nonProxyHosts configuration.

    Entries can use the * wildcard character for pattern matching, e.g *.example.com matches www.example.com.

    Returns string[]

getOpenSslEngineOptions

getPemKeyCertOptions

getPemTrustOptions

getPfxKeyCertOptions

getPfxTrustOptions

getProxyOptions

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

    Returns ProxyOptions

getReadIdleTimeout

  • getReadIdleTimeout(): number
  • Set the read idle timeout, default time unit is seconds. Zero means don't timeout. This determines if a connection will timeout and be closed if no data is received within the timeout.

    If you want change default time unit, use ClientOptionsBase

    Returns number

getReceiveBufferSize

  • getReceiveBufferSize(): 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

getSslHandshakeTimeout

  • getSslHandshakeTimeout(): number
  • Set the SSL handshake timeout, default time unit is seconds.

    Returns number

getSslHandshakeTimeoutUnit

  • getSslHandshakeTimeoutUnit(): any
  • Set the SSL handshake timeout unit. If not specified, default is seconds.

    Returns any

getTcpUserTimeout

  • getTcpUserTimeout(): number
  • Sets the TCP_USER_TIMEOUT option - only with linux native transport.

    Returns number

getTrafficClass

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

    Returns number

getTrustOptions

getTrustStoreOptions

getWriteIdleTimeout

  • getWriteIdleTimeout(): number
  • Set the write idle timeout, default time unit is seconds. Zero means don't timeout. This determines if a connection will timeout and be closed if no data is sent within the timeout.

    If you want change default time unit, use ClientOptionsBase

    Returns number

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

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

isUseAlpn

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

    Returns boolean

setActivityLogDataFormat

  • Set the value of Netty's logging handler's data format: Netty's pipeline is configured for logging on Netty's logger.

    Parameters

    • activityLogDataFormat: any

    Returns ClientOptionsBase

setConnectTimeout

  • Set the connect timeout

    Parameters

    • connectTimeout: number

    Returns ClientOptionsBase

setEnabledSecureTransportProtocols

  • setEnabledSecureTransportProtocols(enabledSecureTransportProtocols: string[]): ClientOptionsBase

setIdleTimeout

  • Set the idle timeout, default time unit is seconds. Zero means don't timeout. This determines if a connection will timeout and be closed if no data is received nor sent within the timeout.

    If you want change default time unit, use ClientOptionsBase

    Parameters

    • idleTimeout: number

    Returns ClientOptionsBase

setIdleTimeoutUnit

setJdkSslEngineOptions

setKeyCertOptions

  • Set the key/cert options.

    Parameters

    Returns ClientOptionsBase

setKeyStoreOptions

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 ClientOptionsBase

setLogActivity

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

    Parameters

    • logActivity: boolean

    Returns ClientOptionsBase

setMetricsName

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

    Parameters

    • metricsName: string

    Returns ClientOptionsBase

setNonProxyHosts

  • Set a list of remote hosts that are not proxied when the client is configured to use a proxy. This list serves the same purpose than the JVM nonProxyHosts configuration.

    Entries can use the * wildcard character for pattern matching, e.g *.example.com matches www.example.com.

    Parameters

    • nonProxyHosts: string[]

    Returns ClientOptionsBase

setOpenSslEngineOptions

setPemKeyCertOptions

setPemTrustOptions

setPfxKeyCertOptions

setPfxTrustOptions

setProxyOptions

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

    Parameters

    Returns ClientOptionsBase

setReadIdleTimeout

  • Set the read idle timeout, default time unit is seconds. Zero means don't timeout. This determines if a connection will timeout and be closed if no data is received within the timeout.

    If you want change default time unit, use ClientOptionsBase

    Parameters

    • readIdleTimeout: number

    Returns ClientOptionsBase

setReceiveBufferSize

setReuseAddress

setReusePort

  • Set the value of reuse port.

    This is only supported by native transports.

    Parameters

    • reusePort: boolean

    Returns ClientOptionsBase

setSendBufferSize

setSoLinger

setSsl

  • Set whether SSL/TLS is enabled

    Parameters

    • ssl: boolean

    Returns ClientOptionsBase

setSslEngineOptions

setSslHandshakeTimeout

setSslHandshakeTimeoutUnit

setTcpCork

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

    Parameters

    • tcpCork: boolean

    Returns ClientOptionsBase

setTcpFastOpen

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

    Parameters

    • tcpFastOpen: boolean

    Returns ClientOptionsBase

setTcpKeepAlive

setTcpNoDelay

setTcpQuickAck

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

    Parameters

    • tcpQuickAck: boolean

    Returns ClientOptionsBase

setTcpUserTimeout

  • Sets the TCP_USER_TIMEOUT option - only with linux native transport.

    Parameters

    • tcpUserTimeout: number

    Returns ClientOptionsBase

setTrafficClass

setTrustAll

  • Set whether all server certificates should be trusted

    Parameters

    • trustAll: boolean

    Returns ClientOptionsBase

setTrustOptions

setTrustStoreOptions

setUseAlpn

setWriteIdleTimeout

  • Set the write idle timeout, default time unit is seconds. Zero means don't timeout. This determines if a connection will timeout and be closed if no data is sent within the timeout.

    If you want change default time unit, use ClientOptionsBase

    Parameters

    • writeIdleTimeout: number

    Returns ClientOptionsBase

toJson

  • toJson(): {}
  • Returns {}

    • [key: string]: any

Generated using TypeDoc