Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WebClientOptions

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

addCrlPath

  • Parameters

    • crlPaths: string

    Returns WebClientOptions

addCrlValue

  • Parameters

    • crlValues: Buffer

    Returns WebClientOptions

addEnabledCipherSuite

  • Parameters

    • enabledCipherSuites: string

    Returns WebClientOptions

addEnabledSecureTransportProtocol

  • addEnabledSecureTransportProtocol(enabledSecureTransportProtocols: string): WebClientOptions
  • Parameters

    • enabledSecureTransportProtocols: string

    Returns WebClientOptions

addNonProxyHost

  • Parameters

    • nonProxyHosts: string

    Returns WebClientOptions

getActivityLogDataFormat

  • getActivityLogDataFormat(): any
  • Returns any

getAlpnVersions

  • getAlpnVersions(): HttpVersion[]
  • Returns HttpVersion[]

getConnectTimeout

  • getConnectTimeout(): number
  • Returns number

getCrlPaths

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

getCrlValues

  • getCrlValues(): Buffer[]
  • Returns Buffer[]

getDecoderInitialBufferSize

  • getDecoderInitialBufferSize(): number
  • Returns number

getDefaultHost

  • getDefaultHost(): string
  • Returns string

getDefaultPort

  • getDefaultPort(): number
  • Returns number

getEnabledCipherSuites

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

getEnabledSecureTransportProtocols

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

getHttp2ConnectionWindowSize

  • getHttp2ConnectionWindowSize(): number
  • Returns number

getHttp2KeepAliveTimeout

  • getHttp2KeepAliveTimeout(): number
  • Returns number

getHttp2MaxPoolSize

  • getHttp2MaxPoolSize(): number
  • Returns number

getHttp2MultiplexingLimit

  • getHttp2MultiplexingLimit(): number
  • Returns number

getIdleTimeout

  • getIdleTimeout(): number
  • Returns number

getIdleTimeoutUnit

  • getIdleTimeoutUnit(): any
  • Returns any

getInitialSettings

  • getInitialSettings(): Http2Settings
  • Returns Http2Settings

getJdkSslEngineOptions

  • getJdkSslEngineOptions(): JdkSSLEngineOptions
  • Returns JdkSSLEngineOptions

getKeepAliveTimeout

  • getKeepAliveTimeout(): number
  • Returns number

getKeyStoreOptions

  • getKeyStoreOptions(): JksOptions
  • Returns JksOptions

getLocalAddress

  • getLocalAddress(): string
  • Returns string

getLogActivity

  • getLogActivity(): boolean
  • Returns boolean

getMaxChunkSize

  • getMaxChunkSize(): number
  • Returns number

getMaxHeaderSize

  • getMaxHeaderSize(): number
  • Returns number

getMaxInitialLineLength

  • getMaxInitialLineLength(): number
  • Returns number

getMaxPoolSize

  • getMaxPoolSize(): number
  • Returns number

getMaxRedirects

  • getMaxRedirects(): number
  • Returns number

getMaxWaitQueueSize

  • getMaxWaitQueueSize(): number
  • Returns number

getMaxWebSocketFrameSize

  • getMaxWebSocketFrameSize(): number
  • Returns number

getMaxWebSocketMessageSize

  • getMaxWebSocketMessageSize(): number
  • Returns number

getMaxWebSockets

  • getMaxWebSockets(): number
  • Returns number

getMetricsName

  • getMetricsName(): string
  • Returns string

getName

  • getName(): string
  • Returns string

getNonProxyHosts

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

getOpenSslEngineOptions

  • getOpenSslEngineOptions(): OpenSSLEngineOptions
  • Returns OpenSSLEngineOptions

getPemKeyCertOptions

  • getPemKeyCertOptions(): PemKeyCertOptions
  • Returns PemKeyCertOptions

getPemTrustOptions

  • getPemTrustOptions(): PemTrustOptions
  • Returns PemTrustOptions

getPfxKeyCertOptions

  • getPfxKeyCertOptions(): PfxOptions
  • Returns PfxOptions

getPfxTrustOptions

  • getPfxTrustOptions(): PfxOptions
  • Returns PfxOptions

getPipeliningLimit

  • getPipeliningLimit(): number
  • Returns number

getPoolCleanerPeriod

  • getPoolCleanerPeriod(): number
  • Returns number

getPoolEventLoopSize

  • getPoolEventLoopSize(): number
  • Returns number

getProtocolVersion

  • getProtocolVersion(): HttpVersion
  • Returns HttpVersion

getProxyOptions

  • getProxyOptions(): ProxyOptions
  • Returns ProxyOptions

getReadIdleTimeout

  • getReadIdleTimeout(): number
  • Returns number

getReceiveBufferSize

  • getReceiveBufferSize(): number
  • Returns number

getSendBufferSize

  • getSendBufferSize(): number
  • Returns number

getSoLinger

  • getSoLinger(): number
  • Returns number

getSslEngineOptions

  • getSslEngineOptions(): any
  • Returns any

getSslHandshakeTimeout

  • getSslHandshakeTimeout(): number
  • Returns number

getSslHandshakeTimeoutUnit

  • getSslHandshakeTimeoutUnit(): any
  • Returns any

getTcpUserTimeout

  • getTcpUserTimeout(): number
  • Returns number

getTemplateExpandOptions

  • getTemplateExpandOptions(): ExpandOptions
  • Returns ExpandOptions

getTracingPolicy

  • getTracingPolicy(): TracingPolicy
  • Returns TracingPolicy

getTrafficClass

  • getTrafficClass(): number
  • Returns number

getTrustOptions

  • getTrustOptions(): any
  • Returns any

getTrustStoreOptions

  • getTrustStoreOptions(): JksOptions
  • 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
  • Returns boolean

isHttp2ClearTextUpgrade

  • isHttp2ClearTextUpgrade(): boolean
  • Returns boolean

isHttp2ClearTextUpgradeWithPreflightRequest

  • isHttp2ClearTextUpgradeWithPreflightRequest(): boolean
  • Returns boolean

isKeepAlive

  • isKeepAlive(): boolean
  • Returns boolean

isPipelining

  • isPipelining(): boolean
  • Returns boolean

isReuseAddress

  • isReuseAddress(): boolean
  • Returns boolean

isReusePort

  • isReusePort(): boolean
  • Returns boolean

isSendUnmaskedFrames

  • isSendUnmaskedFrames(): boolean
  • Returns boolean

isShared

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

isTrustAll

  • isTrustAll(): boolean
  • Returns boolean

isTryUseCompression

  • isTryUseCompression(): boolean
  • Returns boolean

isUseAlpn

  • isUseAlpn(): boolean
  • Returns boolean

isUserAgentEnabled

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

    Returns boolean

isVerifyHost

  • isVerifyHost(): boolean
  • Returns boolean

setActivityLogDataFormat

  • Parameters

    • activityLogDataFormat: any

    Returns WebClientOptions

setAlpnVersions

  • Parameters

    • alpnVersions: HttpVersion[]

    Returns WebClientOptions

setConnectTimeout

  • Parameters

    • connectTimeout: number

    Returns WebClientOptions

setDecoderInitialBufferSize

  • setDecoderInitialBufferSize(decoderInitialBufferSize: number): WebClientOptions
  • Parameters

    • decoderInitialBufferSize: number

    Returns WebClientOptions

setDefaultHost

  • Parameters

    • defaultHost: string

    Returns WebClientOptions

setDefaultPort

  • Parameters

    • defaultPort: number

    Returns WebClientOptions

setEnabledSecureTransportProtocols

  • setEnabledSecureTransportProtocols(enabledSecureTransportProtocols: string[]): WebClientOptions
  • Parameters

    • enabledSecureTransportProtocols: string[]

    Returns WebClientOptions

setFollowRedirects

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

    Parameters

    • followRedirects: boolean

    Returns WebClientOptions

setForceSni

  • Parameters

    • forceSni: boolean

    Returns WebClientOptions

setHttp2ClearTextUpgrade

  • Parameters

    • http2ClearTextUpgrade: boolean

    Returns WebClientOptions

setHttp2ClearTextUpgradeWithPreflightRequest

  • setHttp2ClearTextUpgradeWithPreflightRequest(http2ClearTextUpgradeWithPreflightRequest: boolean): WebClientOptions
  • Parameters

    • http2ClearTextUpgradeWithPreflightRequest: boolean

    Returns WebClientOptions

setHttp2ConnectionWindowSize

  • setHttp2ConnectionWindowSize(http2ConnectionWindowSize: number): WebClientOptions
  • Parameters

    • http2ConnectionWindowSize: number

    Returns WebClientOptions

setHttp2KeepAliveTimeout

  • Parameters

    • http2KeepAliveTimeout: number

    Returns WebClientOptions

setHttp2MaxPoolSize

  • Parameters

    • http2MaxPoolSize: number

    Returns WebClientOptions

setHttp2MultiplexingLimit

  • Parameters

    • http2MultiplexingLimit: number

    Returns WebClientOptions

setIdleTimeout

  • Parameters

    • idleTimeout: number

    Returns WebClientOptions

setIdleTimeoutUnit

  • Parameters

    • idleTimeoutUnit: any

    Returns WebClientOptions

setInitialSettings

  • Parameters

    • initialSettings: Http2Settings

    Returns WebClientOptions

setJdkSslEngineOptions

  • setJdkSslEngineOptions(jdkSslEngineOptions: JdkSSLEngineOptions): WebClientOptions
  • Parameters

    • jdkSslEngineOptions: JdkSSLEngineOptions

    Returns WebClientOptions

setKeepAlive

  • Parameters

    • keepAlive: boolean

    Returns WebClientOptions

setKeepAliveTimeout

  • Parameters

    • keepAliveTimeout: number

    Returns WebClientOptions

setKeyCertOptions

  • Parameters

    • keyCertOptions: any

    Returns WebClientOptions

setKeyStoreOptions

  • Parameters

    • keyStoreOptions: JksOptions

    Returns WebClientOptions

setLocalAddress

  • Parameters

    • localAddress: string

    Returns WebClientOptions

setLogActivity

  • Parameters

    • logActivity: boolean

    Returns WebClientOptions

setMaxChunkSize

  • Parameters

    • maxChunkSize: number

    Returns WebClientOptions

setMaxHeaderSize

  • Parameters

    • maxHeaderSize: number

    Returns WebClientOptions

setMaxInitialLineLength

  • Parameters

    • maxInitialLineLength: number

    Returns WebClientOptions

setMaxPoolSize

  • Parameters

    • maxPoolSize: number

    Returns WebClientOptions

setMaxRedirects

  • Parameters

    • maxRedirects: number

    Returns WebClientOptions

setMaxWaitQueueSize

  • Parameters

    • maxWaitQueueSize: number

    Returns WebClientOptions

setMaxWebSocketFrameSize

  • Parameters

    • maxWebSocketFrameSize: number

    Returns WebClientOptions

setMaxWebSocketMessageSize

  • Parameters

    • maxWebSocketMessageSize: number

    Returns WebClientOptions

setMaxWebSockets

  • Parameters

    • maxWebSockets: number

    Returns WebClientOptions

setMetricsName

  • Parameters

    • metricsName: string

    Returns WebClientOptions

setName

  • Parameters

    • name: string

    Returns WebClientOptions

setNonProxyHosts

  • Parameters

    • nonProxyHosts: string[]

    Returns WebClientOptions

setOpenSslEngineOptions

  • setOpenSslEngineOptions(openSslEngineOptions: OpenSSLEngineOptions): WebClientOptions
  • Parameters

    • openSslEngineOptions: OpenSSLEngineOptions

    Returns WebClientOptions

setPemKeyCertOptions

  • Parameters

    • pemKeyCertOptions: PemKeyCertOptions

    Returns WebClientOptions

setPemTrustOptions

  • Parameters

    • pemTrustOptions: PemTrustOptions

    Returns WebClientOptions

setPfxKeyCertOptions

  • Parameters

    • pfxKeyCertOptions: PfxOptions

    Returns WebClientOptions

setPfxTrustOptions

  • Parameters

    • pfxTrustOptions: PfxOptions

    Returns WebClientOptions

setPipelining

  • Parameters

    • pipelining: boolean

    Returns WebClientOptions

setPipeliningLimit

  • Parameters

    • pipeliningLimit: number

    Returns WebClientOptions

setPoolCleanerPeriod

  • Parameters

    • poolCleanerPeriod: number

    Returns WebClientOptions

setPoolEventLoopSize

  • Parameters

    • poolEventLoopSize: number

    Returns WebClientOptions

setProtocolVersion

  • Parameters

    • protocolVersion: HttpVersion

    Returns WebClientOptions

setProxyOptions

  • Parameters

    • proxyOptions: ProxyOptions

    Returns WebClientOptions

setReadIdleTimeout

  • Parameters

    • readIdleTimeout: number

    Returns WebClientOptions

setReceiveBufferSize

  • Parameters

    • receiveBufferSize: number

    Returns WebClientOptions

setReuseAddress

  • Parameters

    • reuseAddress: boolean

    Returns WebClientOptions

setReusePort

  • Parameters

    • reusePort: boolean

    Returns WebClientOptions

setSendBufferSize

  • Parameters

    • sendBufferSize: number

    Returns WebClientOptions

setSendUnmaskedFrames

  • Parameters

    • sendUnmaskedFrames: boolean

    Returns WebClientOptions

setShared

  • Parameters

    • shared: boolean

    Returns WebClientOptions

setSoLinger

  • Parameters

    • soLinger: number

    Returns WebClientOptions

setSsl

  • Parameters

    • ssl: boolean

    Returns WebClientOptions

setSslEngineOptions

  • Parameters

    • sslEngineOptions: any

    Returns WebClientOptions

setSslHandshakeTimeout

  • Parameters

    • sslHandshakeTimeout: number

    Returns WebClientOptions

setSslHandshakeTimeoutUnit

  • Parameters

    • sslHandshakeTimeoutUnit: any

    Returns WebClientOptions

setTcpCork

  • Parameters

    • tcpCork: boolean

    Returns WebClientOptions

setTcpFastOpen

  • Parameters

    • tcpFastOpen: boolean

    Returns WebClientOptions

setTcpKeepAlive

  • Parameters

    • tcpKeepAlive: boolean

    Returns WebClientOptions

setTcpNoDelay

  • Parameters

    • tcpNoDelay: boolean

    Returns WebClientOptions

setTcpQuickAck

  • Parameters

    • tcpQuickAck: boolean

    Returns WebClientOptions

setTcpUserTimeout

  • Parameters

    • tcpUserTimeout: number

    Returns WebClientOptions

setTemplateExpandOptions

  • setTemplateExpandOptions(templateExpandOptions: ExpandOptions): WebClientOptions
  • Parameters

    • templateExpandOptions: ExpandOptions

    Returns WebClientOptions

setTracingPolicy

  • Parameters

    • tracingPolicy: TracingPolicy

    Returns WebClientOptions

setTrafficClass

  • Parameters

    • trafficClass: number

    Returns WebClientOptions

setTrustAll

  • Parameters

    • trustAll: boolean

    Returns WebClientOptions

setTrustOptions

  • Parameters

    • trustOptions: any

    Returns WebClientOptions

setTrustStoreOptions

  • Parameters

    • trustStoreOptions: JksOptions

    Returns WebClientOptions

setTryUseCompression

  • Parameters

    • tryUseCompression: boolean

    Returns WebClientOptions

setTryUsePerFrameWebSocketCompression

  • setTryUsePerFrameWebSocketCompression(tryUsePerFrameWebSocketCompression: boolean): WebClientOptions
  • Parameters

    • tryUsePerFrameWebSocketCompression: boolean

    Returns WebClientOptions

setTryUsePerMessageWebSocketCompression

  • setTryUsePerMessageWebSocketCompression(tryUsePerMessageWebSocketCompression: boolean): WebClientOptions
  • Parameters

    • tryUsePerMessageWebSocketCompression: boolean

    Returns WebClientOptions

setUseAlpn

  • Parameters

    • useAlpn: boolean

    Returns WebClientOptions

setUserAgent

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

    Parameters

    • userAgent: string

    Returns WebClientOptions

setUserAgentEnabled

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

    Parameters

    • userAgentEnabled: boolean

    Returns WebClientOptions

setVerifyHost

  • Parameters

    • verifyHost: boolean

    Returns WebClientOptions

setWebSocketClosingTimeout

  • Parameters

    • webSocketClosingTimeout: number

    Returns WebClientOptions

setWebSocketCompressionAllowClientNoContext

  • setWebSocketCompressionAllowClientNoContext(webSocketCompressionAllowClientNoContext: boolean): WebClientOptions
  • Parameters

    • webSocketCompressionAllowClientNoContext: boolean

    Returns WebClientOptions

setWebSocketCompressionLevel

  • setWebSocketCompressionLevel(webSocketCompressionLevel: number): WebClientOptions
  • Parameters

    • webSocketCompressionLevel: number

    Returns WebClientOptions

setWebSocketCompressionRequestServerNoContext

  • setWebSocketCompressionRequestServerNoContext(webSocketCompressionRequestServerNoContext: boolean): WebClientOptions
  • Parameters

    • webSocketCompressionRequestServerNoContext: boolean

    Returns WebClientOptions

setWriteIdleTimeout

  • Parameters

    • writeIdleTimeout: number

    Returns WebClientOptions

toJson

  • toJson(): {}
  • Returns {}

    • [key: string]: any

Generated using TypeDoc