Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HttpTermOptions

The web term configuration options.

Hierarchy

  • HttpTermOptions

Index

Constructors

Methods

Constructors

constructor

Methods

addCrlPath

  • Parameters

    • crlPaths: string

    Returns HttpTermOptions

addCrlValue

  • Parameters

    • crlValues: Buffer

    Returns HttpTermOptions

addEnabledCipherSuite

  • Parameters

    • enabledCipherSuites: string

    Returns HttpTermOptions

addEnabledSecureTransportProtocol

  • addEnabledSecureTransportProtocol(enabledSecureTransportProtocols: string): HttpTermOptions
  • Parameters

    • enabledSecureTransportProtocols: string

    Returns HttpTermOptions

addWebSocketSubProtocol

  • Parameters

    • webSocketSubProtocols: string

    Returns HttpTermOptions

getAcceptBacklog

  • getAcceptBacklog(): number
  • Returns number

getAlpnVersions

  • getAlpnVersions(): HttpVersion
  • Returns HttpVersion

getAuthOptions

  • getAuthOptions(): {}
  • Set the auth options.

    Returns {}

    • [key: string]: any

getCharset

  • getCharset(): string
  • Set the charset used for encoding / decoding text data from/to SockJS

    Returns string

getClientAuth

  • getClientAuth(): ClientAuth
  • Returns ClientAuth

getCompressionLevel

  • getCompressionLevel(): number
  • Returns number

getCrlPaths

  • getCrlPaths(): string
  • Returns string

getCrlValues

  • getCrlValues(): Buffer
  • Returns Buffer

getDecoderInitialBufferSize

  • getDecoderInitialBufferSize(): number
  • Returns number

getEnabledCipherSuites

  • getEnabledCipherSuites(): string
  • Returns string

getEnabledSecureTransportProtocols

  • getEnabledSecureTransportProtocols(): string
  • Returns string

getHost

  • getHost(): string
  • Returns string

getHttp2ConnectionWindowSize

  • getHttp2ConnectionWindowSize(): number
  • Returns number

getIdleTimeout

  • getIdleTimeout(): number
  • Returns number

getIdleTimeoutUnit

  • getIdleTimeoutUnit(): any
  • Returns any

getInitialSettings

  • getInitialSettings(): Http2Settings
  • Returns Http2Settings

getIntputrc

  • getIntputrc(): string
  • The path of the inputrc config.

    Returns string

getJdkSslEngineOptions

  • getJdkSslEngineOptions(): JdkSSLEngineOptions
  • Returns JdkSSLEngineOptions

getKeyStoreOptions

  • getKeyStoreOptions(): JksOptions
  • Returns JksOptions

getLogActivity

  • getLogActivity(): boolean
  • Returns boolean

getMaxChunkSize

  • getMaxChunkSize(): number
  • Returns number

getMaxHeaderSize

  • getMaxHeaderSize(): number
  • Returns number

getMaxInitialLineLength

  • getMaxInitialLineLength(): number
  • Returns number

getMaxWebSocketFrameSize

  • getMaxWebSocketFrameSize(): number
  • Returns number

getMaxWebSocketMessageSize

  • getMaxWebSocketMessageSize(): number
  • Returns number

getOpenSslEngineOptions

  • getOpenSslEngineOptions(): OpenSSLEngineOptions
  • Returns OpenSSLEngineOptions

getPemKeyCertOptions

  • getPemKeyCertOptions(): PemKeyCertOptions
  • Returns PemKeyCertOptions

getPemTrustOptions

  • getPemTrustOptions(): PemTrustOptions
  • Returns PemTrustOptions

getPerFrameWebSocketCompressionSupported

  • getPerFrameWebSocketCompressionSupported(): boolean
  • Returns boolean

getPerMessageWebSocketCompressionSupported

  • getPerMessageWebSocketCompressionSupported(): boolean
  • Returns boolean

getPfxKeyCertOptions

  • getPfxKeyCertOptions(): PfxOptions
  • Returns PfxOptions

getPfxTrustOptions

  • getPfxTrustOptions(): PfxOptions
  • Returns PfxOptions

getPort

  • getPort(): number
  • Returns number

getProxyProtocolTimeout

  • getProxyProtocolTimeout(): number
  • Returns number

getProxyProtocolTimeoutUnit

  • getProxyProtocolTimeoutUnit(): any
  • Returns any

getReceiveBufferSize

  • getReceiveBufferSize(): number
  • Returns number

getSendBufferSize

  • getSendBufferSize(): number
  • Returns number

getShellHtmlResource

  • getShellHtmlResource(): Buffer
  • Set shell.html resource to use.

    Returns Buffer

getSoLinger

  • getSoLinger(): number
  • Returns number

getSockJSHandlerOptions

  • getSockJSHandlerOptions(): SockJSHandlerOptions
  • The SockJS handler options.

    Returns SockJSHandlerOptions

getSockJSPath

  • getSockJSPath(): string
  • Configure the SockJS path, the default value is /term/*.

    Returns string

getSslEngineOptions

  • getSslEngineOptions(): any
  • Returns any

getSslHandshakeTimeout

  • getSslHandshakeTimeout(): number
  • Returns number

getSslHandshakeTimeoutUnit

  • getSslHandshakeTimeoutUnit(): any
  • Returns any

getTermJsResource

  • getTermJsResource(): Buffer
  • Set term.js resource to use.

    Returns Buffer

getTracingPolicy

  • getTracingPolicy(): TracingPolicy
  • Returns TracingPolicy

getTrafficClass

  • getTrafficClass(): number
  • Returns number

getTrustOptions

  • getTrustOptions(): any
  • Returns any

getTrustStoreOptions

  • getTrustStoreOptions(): JksOptions
  • Returns JksOptions

getVertsShellJsResource

  • getVertsShellJsResource(): Buffer
  • Set vertxshell.js resource to use.

    Returns Buffer

getWebSocketAllowServerNoContext

  • getWebSocketAllowServerNoContext(): boolean
  • Returns boolean

getWebSocketCompressionLevel

  • getWebSocketCompressionLevel(): number
  • Returns number

getWebSocketPreferredClientNoContext

  • getWebSocketPreferredClientNoContext(): boolean
  • Returns boolean

getWebSocketSubProtocols

  • getWebSocketSubProtocols(): string
  • Returns string

isAcceptUnmaskedFrames

  • isAcceptUnmaskedFrames(): boolean
  • Returns boolean

isCompressionSupported

  • isCompressionSupported(): boolean
  • Returns boolean

isDecompressionSupported

  • isDecompressionSupported(): boolean
  • Returns boolean

isHandle100ContinueAutomatically

  • isHandle100ContinueAutomatically(): boolean
  • Returns boolean

isReuseAddress

  • isReuseAddress(): boolean
  • Returns boolean

isReusePort

  • isReusePort(): boolean
  • Returns boolean

isSni

  • isSni(): boolean
  • Returns boolean

isSsl

  • isSsl(): boolean
  • Returns boolean

isTcpCork

  • isTcpCork(): boolean
  • Returns boolean

isTcpFastOpen

  • isTcpFastOpen(): boolean
  • Returns boolean

isTcpKeepAlive

  • isTcpKeepAlive(): boolean
  • Returns boolean

isTcpNoDelay

  • isTcpNoDelay(): boolean
  • Returns boolean

isTcpQuickAck

  • isTcpQuickAck(): boolean
  • Returns boolean

isUseAlpn

  • isUseAlpn(): boolean
  • Returns boolean

isUseProxyProtocol

  • isUseProxyProtocol(): boolean
  • Returns boolean

setAcceptBacklog

  • Parameters

    • acceptBacklog: number

    Returns HttpTermOptions

setAcceptUnmaskedFrames

  • Parameters

    • acceptUnmaskedFrames: boolean

    Returns HttpTermOptions

setAlpnVersions

  • Parameters

    • alpnVersions: HttpVersion

    Returns HttpTermOptions

setAuthOptions

  • Set the auth options.

    Parameters

    • authOptions: {}
      • [key: string]: any

    Returns HttpTermOptions

setCharset

  • Set the charset used for encoding / decoding text data from/to SockJS

    Parameters

    • charset: string

    Returns HttpTermOptions

setClientAuth

  • Parameters

    • clientAuth: ClientAuth

    Returns HttpTermOptions

setCompressionLevel

  • Parameters

    • compressionLevel: number

    Returns HttpTermOptions

setCompressionSupported

  • Parameters

    • compressionSupported: boolean

    Returns HttpTermOptions

setDecoderInitialBufferSize

  • setDecoderInitialBufferSize(decoderInitialBufferSize: number): HttpTermOptions
  • Parameters

    • decoderInitialBufferSize: number

    Returns HttpTermOptions

setDecompressionSupported

  • setDecompressionSupported(decompressionSupported: boolean): HttpTermOptions
  • Parameters

    • decompressionSupported: boolean

    Returns HttpTermOptions

setEnabledSecureTransportProtocols

  • setEnabledSecureTransportProtocols(enabledSecureTransportProtocols: string): HttpTermOptions
  • Parameters

    • enabledSecureTransportProtocols: string

    Returns HttpTermOptions

setHandle100ContinueAutomatically

  • setHandle100ContinueAutomatically(handle100ContinueAutomatically: boolean): HttpTermOptions
  • Parameters

    • handle100ContinueAutomatically: boolean

    Returns HttpTermOptions

setHost

  • Parameters

    • host: string

    Returns HttpTermOptions

setHttp2ConnectionWindowSize

  • setHttp2ConnectionWindowSize(http2ConnectionWindowSize: number): HttpTermOptions
  • Parameters

    • http2ConnectionWindowSize: number

    Returns HttpTermOptions

setIdleTimeout

  • Parameters

    • idleTimeout: number

    Returns HttpTermOptions

setIdleTimeoutUnit

  • Parameters

    • idleTimeoutUnit: any

    Returns HttpTermOptions

setInitialSettings

  • Parameters

    • initialSettings: Http2Settings

    Returns HttpTermOptions

setIntputrc

  • The path of the inputrc config.

    Parameters

    • intputrc: string

    Returns HttpTermOptions

setJdkSslEngineOptions

  • setJdkSslEngineOptions(jdkSslEngineOptions: JdkSSLEngineOptions): HttpTermOptions
  • Parameters

    • jdkSslEngineOptions: JdkSSLEngineOptions

    Returns HttpTermOptions

setKeyCertOptions

  • Parameters

    • keyCertOptions: any

    Returns HttpTermOptions

setKeyStoreOptions

  • Parameters

    • keyStoreOptions: JksOptions

    Returns HttpTermOptions

setLogActivity

  • Parameters

    • logActivity: boolean

    Returns HttpTermOptions

setMaxChunkSize

  • Parameters

    • maxChunkSize: number

    Returns HttpTermOptions

setMaxHeaderSize

  • Parameters

    • maxHeaderSize: number

    Returns HttpTermOptions

setMaxInitialLineLength

  • Parameters

    • maxInitialLineLength: number

    Returns HttpTermOptions

setMaxWebSocketFrameSize

  • Parameters

    • maxWebSocketFrameSize: number

    Returns HttpTermOptions

setMaxWebSocketMessageSize

  • setMaxWebSocketMessageSize(maxWebSocketMessageSize: number): HttpTermOptions
  • Parameters

    • maxWebSocketMessageSize: number

    Returns HttpTermOptions

setOpenSslEngineOptions

  • setOpenSslEngineOptions(openSslEngineOptions: OpenSSLEngineOptions): HttpTermOptions
  • Parameters

    • openSslEngineOptions: OpenSSLEngineOptions

    Returns HttpTermOptions

setPemKeyCertOptions

  • setPemKeyCertOptions(pemKeyCertOptions: PemKeyCertOptions): HttpTermOptions
  • Parameters

    • pemKeyCertOptions: PemKeyCertOptions

    Returns HttpTermOptions

setPemTrustOptions

  • Parameters

    • pemTrustOptions: PemTrustOptions

    Returns HttpTermOptions

setPerFrameWebSocketCompressionSupported

  • setPerFrameWebSocketCompressionSupported(perFrameWebSocketCompressionSupported: boolean): HttpTermOptions
  • Parameters

    • perFrameWebSocketCompressionSupported: boolean

    Returns HttpTermOptions

setPerMessageWebSocketCompressionSupported

  • setPerMessageWebSocketCompressionSupported(perMessageWebSocketCompressionSupported: boolean): HttpTermOptions
  • Parameters

    • perMessageWebSocketCompressionSupported: boolean

    Returns HttpTermOptions

setPfxKeyCertOptions

  • Parameters

    • pfxKeyCertOptions: PfxOptions

    Returns HttpTermOptions

setPfxTrustOptions

  • Parameters

    • pfxTrustOptions: PfxOptions

    Returns HttpTermOptions

setPort

  • Parameters

    • port: number

    Returns HttpTermOptions

setProxyProtocolTimeout

  • Parameters

    • proxyProtocolTimeout: number

    Returns HttpTermOptions

setProxyProtocolTimeoutUnit

  • setProxyProtocolTimeoutUnit(proxyProtocolTimeoutUnit: any): HttpTermOptions
  • Parameters

    • proxyProtocolTimeoutUnit: any

    Returns HttpTermOptions

setReceiveBufferSize

  • Parameters

    • receiveBufferSize: number

    Returns HttpTermOptions

setReuseAddress

  • Parameters

    • reuseAddress: boolean

    Returns HttpTermOptions

setReusePort

  • Parameters

    • reusePort: boolean

    Returns HttpTermOptions

setSendBufferSize

  • Parameters

    • sendBufferSize: number

    Returns HttpTermOptions

setShellHtmlResource

  • Set shell.html resource to use.

    Parameters

    • shellHtmlResource: Buffer

    Returns HttpTermOptions

setSni

  • Parameters

    • sni: boolean

    Returns HttpTermOptions

setSoLinger

  • Parameters

    • soLinger: number

    Returns HttpTermOptions

setSockJSHandlerOptions

  • setSockJSHandlerOptions(sockJSHandlerOptions: SockJSHandlerOptions): HttpTermOptions
  • The SockJS handler options.

    Parameters

    • sockJSHandlerOptions: SockJSHandlerOptions

    Returns HttpTermOptions

setSockJSPath

  • Configure the SockJS path, the default value is /term/*.

    Parameters

    • sockJSPath: string

    Returns HttpTermOptions

setSsl

  • Parameters

    • ssl: boolean

    Returns HttpTermOptions

setSslEngineOptions

  • Parameters

    • sslEngineOptions: any

    Returns HttpTermOptions

setSslHandshakeTimeout

  • Parameters

    • sslHandshakeTimeout: number

    Returns HttpTermOptions

setSslHandshakeTimeoutUnit

  • setSslHandshakeTimeoutUnit(sslHandshakeTimeoutUnit: any): HttpTermOptions
  • Parameters

    • sslHandshakeTimeoutUnit: any

    Returns HttpTermOptions

setTcpCork

  • Parameters

    • tcpCork: boolean

    Returns HttpTermOptions

setTcpFastOpen

  • Parameters

    • tcpFastOpen: boolean

    Returns HttpTermOptions

setTcpKeepAlive

  • Parameters

    • tcpKeepAlive: boolean

    Returns HttpTermOptions

setTcpNoDelay

  • Parameters

    • tcpNoDelay: boolean

    Returns HttpTermOptions

setTcpQuickAck

  • Parameters

    • tcpQuickAck: boolean

    Returns HttpTermOptions

setTermJsResource

  • Set term.js resource to use.

    Parameters

    • termJsResource: Buffer

    Returns HttpTermOptions

setTracingPolicy

  • Parameters

    • tracingPolicy: TracingPolicy

    Returns HttpTermOptions

setTrafficClass

  • Parameters

    • trafficClass: number

    Returns HttpTermOptions

setTrustOptions

  • Parameters

    • trustOptions: any

    Returns HttpTermOptions

setTrustStoreOptions

  • Parameters

    • trustStoreOptions: JksOptions

    Returns HttpTermOptions

setUseAlpn

  • Parameters

    • useAlpn: boolean

    Returns HttpTermOptions

setUseProxyProtocol

  • Parameters

    • useProxyProtocol: boolean

    Returns HttpTermOptions

setVertsShellJsResource

  • Set vertxshell.js resource to use.

    Parameters

    • vertsShellJsResource: Buffer

    Returns HttpTermOptions

setWebSocketAllowServerNoContext

  • setWebSocketAllowServerNoContext(webSocketAllowServerNoContext: boolean): HttpTermOptions
  • Parameters

    • webSocketAllowServerNoContext: boolean

    Returns HttpTermOptions

setWebSocketCompressionLevel

  • setWebSocketCompressionLevel(webSocketCompressionLevel: number): HttpTermOptions
  • Parameters

    • webSocketCompressionLevel: number

    Returns HttpTermOptions

setWebSocketPreferredClientNoContext

  • setWebSocketPreferredClientNoContext(webSocketPreferredClientNoContext: boolean): HttpTermOptions
  • Parameters

    • webSocketPreferredClientNoContext: boolean

    Returns HttpTermOptions

setWebSocketSubProtocols

  • Parameters

    • webSocketSubProtocols: string

    Returns HttpTermOptions

Generated using TypeDoc