Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TCPSSLOptions

Base class. TCP and SSL related options

Hierarchy

Index

Constructors

constructor

Methods

addCrlPath

  • Add a CRL path

    Parameters

    • crlPaths: string

    Returns TCPSSLOptions

addCrlValue

  • Add a CRL value

    Parameters

    Returns TCPSSLOptions

addEnabledCipherSuite

  • addEnabledCipherSuite(enabledCipherSuites: string): TCPSSLOptions
  • Add an enabled cipher suite, appended to the ordered suites.

    Parameters

    • enabledCipherSuites: string

    Returns TCPSSLOptions

addEnabledSecureTransportProtocol

  • addEnabledSecureTransportProtocol(enabledSecureTransportProtocols: string): TCPSSLOptions
  • Sets the list of enabled SSL/TLS protocols.

    Parameters

    • enabledSecureTransportProtocols: string

    Returns TCPSSLOptions

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

getCrlPaths

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

    Returns string[]

getCrlValues

  • Add a CRL value

    Returns Buffer[]

getEnabledCipherSuites

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

    Returns string[]

getEnabledSecureTransportProtocols

  • getEnabledSecureTransportProtocols(): string[]
  • Sets the list of enabled SSL/TLS protocols.

    Returns 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 TCPSSLOptions

    Returns number

getIdleTimeoutUnit

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

    Returns any

getJdkSslEngineOptions

  • Returns JdkSSLEngineOptions

getKeyStoreOptions

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

    Returns JksOptions

getLogActivity

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

    Returns boolean

getOpenSslEngineOptions

  • Returns OpenSSLEngineOptions

getPemKeyCertOptions

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

    Returns PemKeyCertOptions

getPemTrustOptions

  • Set the trust options in pem format

    Returns PemTrustOptions

getPfxKeyCertOptions

  • Set the key/cert options in pfx format.

    Returns PfxOptions

getPfxTrustOptions

  • Set the trust options in pfx format

    Returns PfxOptions

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 TCPSSLOptions

    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

  • Set to use SSL engine implementation to use.

    Returns SSLEngineOptions

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

  • Set the trust options.

    Returns TrustOptions

getTrustStoreOptions

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

    Returns JksOptions

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 TCPSSLOptions

    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

isUseAlpn

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

    Returns boolean

setActivityLogDataFormat

  • setActivityLogDataFormat(activityLogDataFormat: any): TCPSSLOptions
  • 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 TCPSSLOptions

setEnabledSecureTransportProtocols

  • setEnabledSecureTransportProtocols(enabledSecureTransportProtocols: string[]): TCPSSLOptions
  • Sets the list of enabled SSL/TLS protocols.

    Parameters

    • enabledSecureTransportProtocols: string[]

    Returns TCPSSLOptions

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 TCPSSLOptions

    Parameters

    • idleTimeout: number

    Returns TCPSSLOptions

setIdleTimeoutUnit

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

    Parameters

    • idleTimeoutUnit: any

    Returns TCPSSLOptions

setJdkSslEngineOptions

setKeyStoreOptions

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

    Parameters

    Returns TCPSSLOptions

setLogActivity

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

    Parameters

    • logActivity: boolean

    Returns TCPSSLOptions

setOpenSslEngineOptions

setPemKeyCertOptions

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

    Parameters

    Returns TCPSSLOptions

setPemTrustOptions

  • Set the trust options in pem format

    Parameters

    Returns TCPSSLOptions

setPfxKeyCertOptions

  • Set the key/cert options in pfx format.

    Parameters

    Returns TCPSSLOptions

setPfxTrustOptions

  • Set the trust options in pfx format

    Parameters

    Returns TCPSSLOptions

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 TCPSSLOptions

    Parameters

    • readIdleTimeout: number

    Returns TCPSSLOptions

setReceiveBufferSize

setReuseAddress

setReusePort

  • Set the value of reuse port.

    This is only supported by native transports.

    Parameters

    • reusePort: boolean

    Returns TCPSSLOptions

setSendBufferSize

setSoLinger

  • Set whether SO_linger keep alive is enabled

    Parameters

    • soLinger: number

    Returns TCPSSLOptions

setSsl

  • Set whether SSL/TLS is enabled

    Parameters

    • ssl: boolean

    Returns TCPSSLOptions

setSslEngineOptions

  • Set to use SSL engine implementation to use.

    Parameters

    Returns TCPSSLOptions

setSslHandshakeTimeout

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

    Parameters

    • sslHandshakeTimeout: number

    Returns TCPSSLOptions

setSslHandshakeTimeoutUnit

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

    Parameters

    • sslHandshakeTimeoutUnit: any

    Returns TCPSSLOptions

setTcpCork

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

    Parameters

    • tcpCork: boolean

    Returns TCPSSLOptions

setTcpFastOpen

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

    Parameters

    • tcpFastOpen: boolean

    Returns TCPSSLOptions

setTcpKeepAlive

  • Set whether TCP keep alive is enabled

    Parameters

    • tcpKeepAlive: boolean

    Returns TCPSSLOptions

setTcpNoDelay

  • Set whether TCP no delay is enabled

    Parameters

    • tcpNoDelay: boolean

    Returns TCPSSLOptions

setTcpQuickAck

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

    Parameters

    • tcpQuickAck: boolean

    Returns TCPSSLOptions

setTcpUserTimeout

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

    Parameters

    • tcpUserTimeout: number

    Returns TCPSSLOptions

setTrafficClass

setTrustOptions

  • Set the trust options.

    Parameters

    Returns TCPSSLOptions

setTrustStoreOptions

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

    Parameters

    Returns TCPSSLOptions

setUseAlpn

  • Set the ALPN usage.

    Parameters

    • useAlpn: boolean

    Returns TCPSSLOptions

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 TCPSSLOptions

    Parameters

    • writeIdleTimeout: number

    Returns TCPSSLOptions

toJson

  • toJson(): {}
  • Returns {}

    • [key: string]: any

Generated using TypeDoc