Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NetServerOptions

Options for configuring a NetServer.

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

addCrlPath

addCrlValue

addEnabledCipherSuite

addEnabledSecureTransportProtocol

  • addEnabledSecureTransportProtocol(enabledSecureTransportProtocols: string): NetServerOptions

getAcceptBacklog

  • getAcceptBacklog(): number
  • Set the accept back log

    Returns number

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

getClientAuth

  • Set whether client auth is required

    Returns ClientAuth

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[]

getHost

  • getHost(): string
  • Set the host

    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 NetServerOptions

    Returns number

getIdleTimeoutUnit

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

    Returns any

getJdkSslEngineOptions

getKeyStoreOptions

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

getPemKeyCertOptions

getPemTrustOptions

getPfxKeyCertOptions

getPfxTrustOptions

getPort

  • getPort(): number
  • Set the port

    Returns number

getProxyProtocolTimeout

  • getProxyProtocolTimeout(): number
  • Set the Proxy protocol timeout, default time unit is seconds.

    Returns number

getProxyProtocolTimeoutUnit

  • getProxyProtocolTimeoutUnit(): any
  • Set the Proxy protocol timeout unit. If not specified, default is seconds.

    Returns any

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 NetServerOptions

    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 NetServerOptions

    Returns number

isRegisterWriteHandler

  • isRegisterWriteHandler(): boolean
  • Whether a write-handler should be registered on the EventBus.

    Defaults to false.

    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

isSni

  • isSni(): boolean
  • Set whether the server supports Server Name Indiciation

    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

isUseProxyProtocol

  • isUseProxyProtocol(): boolean
  • Set whether the server uses the HA Proxy protocol

    Returns boolean

setAcceptBacklog

  • Set the accept back log

    Parameters

    • acceptBacklog: number

    Returns NetServerOptions

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 NetServerOptions

setClientAuth

  • Set whether client auth is required

    Parameters

    Returns NetServerOptions

setEnabledSecureTransportProtocols

  • setEnabledSecureTransportProtocols(enabledSecureTransportProtocols: string[]): NetServerOptions

setHost

  • Set the host

    Parameters

    • host: string

    Returns NetServerOptions

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 NetServerOptions

    Parameters

    • idleTimeout: number

    Returns NetServerOptions

setIdleTimeoutUnit

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

    Parameters

    • idleTimeoutUnit: any

    Returns NetServerOptions

setJdkSslEngineOptions

setKeyCertOptions

  • Set the key/cert options.

    Parameters

    Returns NetServerOptions

setKeyStoreOptions

setLogActivity

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

    Parameters

    • logActivity: boolean

    Returns NetServerOptions

setOpenSslEngineOptions

setPemKeyCertOptions

setPemTrustOptions

setPfxKeyCertOptions

setPfxTrustOptions

setPort

  • Set the port

    Parameters

    • port: number

    Returns NetServerOptions

setProxyProtocolTimeout

  • Set the Proxy protocol timeout, default time unit is seconds.

    Parameters

    • proxyProtocolTimeout: number

    Returns NetServerOptions

setProxyProtocolTimeoutUnit

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

    Parameters

    • proxyProtocolTimeoutUnit: any

    Returns NetServerOptions

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 NetServerOptions

    Parameters

    • readIdleTimeout: number

    Returns NetServerOptions

setReceiveBufferSize

setRegisterWriteHandler

  • Whether a write-handler should be registered on the EventBus.

    Defaults to false.

    Parameters

    • registerWriteHandler: boolean

    Returns NetServerOptions

setReuseAddress

setReusePort

  • Set the value of reuse port.

    This is only supported by native transports.

    Parameters

    • reusePort: boolean

    Returns NetServerOptions

setSendBufferSize

setSni

  • Set whether the server supports Server Name Indiciation

    Parameters

    • sni: boolean

    Returns NetServerOptions

setSoLinger

  • Set whether SO_linger keep alive is enabled

    Parameters

    • soLinger: number

    Returns NetServerOptions

setSsl

  • Set whether SSL/TLS is enabled

    Parameters

    • ssl: boolean

    Returns NetServerOptions

setSslEngineOptions

setSslHandshakeTimeout

setSslHandshakeTimeoutUnit

setTcpCork

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

    Parameters

    • tcpCork: boolean

    Returns NetServerOptions

setTcpFastOpen

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

    Parameters

    • tcpFastOpen: boolean

    Returns NetServerOptions

setTcpKeepAlive

setTcpNoDelay

setTcpQuickAck

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

    Parameters

    • tcpQuickAck: boolean

    Returns NetServerOptions

setTcpUserTimeout

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

    Parameters

    • tcpUserTimeout: number

    Returns NetServerOptions

setTrafficClass

setTrustOptions

setTrustStoreOptions

setUseAlpn

setUseProxyProtocol

  • Set whether the server uses the HA Proxy protocol

    Parameters

    • useProxyProtocol: boolean

    Returns NetServerOptions

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 NetServerOptions

    Parameters

    • writeIdleTimeout: number

    Returns NetServerOptions

toJson

  • toJson(): {}
  • Returns {}

    • [key: string]: any

Generated using TypeDoc