Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HttpSenderOptions

Options for reporting to a Zipkin server configured by default to http://localhost:9411/api/v2/spans.

Hierarchy

  • any
    • HttpSenderOptions

Index

Constructors

Methods

Constructors

constructor

Methods

addCrlPath

  • Parameters

    • crlPaths: string

    Returns HttpSenderOptions

addCrlValue

  • Parameters

    • crlValues: Buffer

    Returns HttpSenderOptions

addEnabledCipherSuite

  • Parameters

    • enabledCipherSuites: string

    Returns HttpSenderOptions

addEnabledSecureTransportProtocol

  • addEnabledSecureTransportProtocol(enabledSecureTransportProtocols: string): HttpSenderOptions
  • Parameters

    • enabledSecureTransportProtocols: string

    Returns HttpSenderOptions

addNonProxyHost

  • Parameters

    • nonProxyHosts: string

    Returns HttpSenderOptions

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

getSenderEndpoint

  • getSenderEndpoint(): string
  • Returns string

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

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

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

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

isVerifyHost

  • isVerifyHost(): boolean
  • Returns boolean

setActivityLogDataFormat

  • Parameters

    • activityLogDataFormat: any

    Returns HttpSenderOptions

setAlpnVersions

  • Parameters

    • alpnVersions: HttpVersion[]

    Returns HttpSenderOptions

setConnectTimeout

  • Parameters

    • connectTimeout: number

    Returns HttpSenderOptions

setDecoderInitialBufferSize

  • Parameters

    • decoderInitialBufferSize: number

    Returns HttpSenderOptions

setDefaultHost

  • Parameters

    • defaultHost: string

    Returns HttpSenderOptions

setDefaultPort

  • Parameters

    • defaultPort: number

    Returns HttpSenderOptions

setEnabledSecureTransportProtocols

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

    • enabledSecureTransportProtocols: string[]

    Returns HttpSenderOptions

setForceSni

  • Parameters

    • forceSni: boolean

    Returns HttpSenderOptions

setHttp2ClearTextUpgrade

  • Parameters

    • http2ClearTextUpgrade: boolean

    Returns HttpSenderOptions

setHttp2ClearTextUpgradeWithPreflightRequest

  • setHttp2ClearTextUpgradeWithPreflightRequest(http2ClearTextUpgradeWithPreflightRequest: boolean): HttpSenderOptions
  • Parameters

    • http2ClearTextUpgradeWithPreflightRequest: boolean

    Returns HttpSenderOptions

setHttp2ConnectionWindowSize

  • Parameters

    • http2ConnectionWindowSize: number

    Returns HttpSenderOptions

setHttp2KeepAliveTimeout

  • Parameters

    • http2KeepAliveTimeout: number

    Returns HttpSenderOptions

setHttp2MaxPoolSize

  • Parameters

    • http2MaxPoolSize: number

    Returns HttpSenderOptions

setHttp2MultiplexingLimit

  • Parameters

    • http2MultiplexingLimit: number

    Returns HttpSenderOptions

setIdleTimeout

  • Parameters

    • idleTimeout: number

    Returns HttpSenderOptions

setIdleTimeoutUnit

  • Parameters

    • idleTimeoutUnit: any

    Returns HttpSenderOptions

setInitialSettings

  • Parameters

    • initialSettings: Http2Settings

    Returns HttpSenderOptions

setJdkSslEngineOptions

  • setJdkSslEngineOptions(jdkSslEngineOptions: JdkSSLEngineOptions): HttpSenderOptions
  • Parameters

    • jdkSslEngineOptions: JdkSSLEngineOptions

    Returns HttpSenderOptions

setKeepAlive

  • Parameters

    • keepAlive: boolean

    Returns HttpSenderOptions

setKeepAliveTimeout

  • Parameters

    • keepAliveTimeout: number

    Returns HttpSenderOptions

setKeyCertOptions

  • Parameters

    • keyCertOptions: any

    Returns HttpSenderOptions

setKeyStoreOptions

  • Parameters

    • keyStoreOptions: JksOptions

    Returns HttpSenderOptions

setLocalAddress

  • Parameters

    • localAddress: string

    Returns HttpSenderOptions

setLogActivity

  • Parameters

    • logActivity: boolean

    Returns HttpSenderOptions

setMaxChunkSize

  • Parameters

    • maxChunkSize: number

    Returns HttpSenderOptions

setMaxHeaderSize

  • Parameters

    • maxHeaderSize: number

    Returns HttpSenderOptions

setMaxInitialLineLength

  • Parameters

    • maxInitialLineLength: number

    Returns HttpSenderOptions

setMaxPoolSize

  • Parameters

    • maxPoolSize: number

    Returns HttpSenderOptions

setMaxRedirects

  • Parameters

    • maxRedirects: number

    Returns HttpSenderOptions

setMaxWaitQueueSize

  • Parameters

    • maxWaitQueueSize: number

    Returns HttpSenderOptions

setMaxWebSocketFrameSize

  • Parameters

    • maxWebSocketFrameSize: number

    Returns HttpSenderOptions

setMaxWebSocketMessageSize

  • Parameters

    • maxWebSocketMessageSize: number

    Returns HttpSenderOptions

setMaxWebSockets

  • Parameters

    • maxWebSockets: number

    Returns HttpSenderOptions

setMetricsName

  • Parameters

    • metricsName: string

    Returns HttpSenderOptions

setName

  • Parameters

    • name: string

    Returns HttpSenderOptions

setNonProxyHosts

  • Parameters

    • nonProxyHosts: string[]

    Returns HttpSenderOptions

setOpenSslEngineOptions

  • setOpenSslEngineOptions(openSslEngineOptions: OpenSSLEngineOptions): HttpSenderOptions
  • Parameters

    • openSslEngineOptions: OpenSSLEngineOptions

    Returns HttpSenderOptions

setPemKeyCertOptions

  • Parameters

    • pemKeyCertOptions: PemKeyCertOptions

    Returns HttpSenderOptions

setPemTrustOptions

  • Parameters

    • pemTrustOptions: PemTrustOptions

    Returns HttpSenderOptions

setPfxKeyCertOptions

  • Parameters

    • pfxKeyCertOptions: PfxOptions

    Returns HttpSenderOptions

setPfxTrustOptions

  • Parameters

    • pfxTrustOptions: PfxOptions

    Returns HttpSenderOptions

setPipelining

  • Parameters

    • pipelining: boolean

    Returns HttpSenderOptions

setPipeliningLimit

  • Parameters

    • pipeliningLimit: number

    Returns HttpSenderOptions

setPoolCleanerPeriod

  • Parameters

    • poolCleanerPeriod: number

    Returns HttpSenderOptions

setPoolEventLoopSize

  • Parameters

    • poolEventLoopSize: number

    Returns HttpSenderOptions

setProtocolVersion

  • Parameters

    • protocolVersion: HttpVersion

    Returns HttpSenderOptions

setProxyOptions

  • Parameters

    • proxyOptions: ProxyOptions

    Returns HttpSenderOptions

setReadIdleTimeout

  • Parameters

    • readIdleTimeout: number

    Returns HttpSenderOptions

setReceiveBufferSize

  • Parameters

    • receiveBufferSize: number

    Returns HttpSenderOptions

setReuseAddress

  • Parameters

    • reuseAddress: boolean

    Returns HttpSenderOptions

setReusePort

  • Parameters

    • reusePort: boolean

    Returns HttpSenderOptions

setSendBufferSize

  • Parameters

    • sendBufferSize: number

    Returns HttpSenderOptions

setSendUnmaskedFrames

  • Parameters

    • sendUnmaskedFrames: boolean

    Returns HttpSenderOptions

setSenderEndpoint

  • Parameters

    • senderEndpoint: string

    Returns HttpSenderOptions

setShared

  • Parameters

    • shared: boolean

    Returns HttpSenderOptions

setSoLinger

  • Parameters

    • soLinger: number

    Returns HttpSenderOptions

setSsl

  • Parameters

    • ssl: boolean

    Returns HttpSenderOptions

setSslEngineOptions

  • Parameters

    • sslEngineOptions: any

    Returns HttpSenderOptions

setSslHandshakeTimeout

  • Parameters

    • sslHandshakeTimeout: number

    Returns HttpSenderOptions

setSslHandshakeTimeoutUnit

  • Parameters

    • sslHandshakeTimeoutUnit: any

    Returns HttpSenderOptions

setTcpCork

  • Parameters

    • tcpCork: boolean

    Returns HttpSenderOptions

setTcpFastOpen

  • Parameters

    • tcpFastOpen: boolean

    Returns HttpSenderOptions

setTcpKeepAlive

  • Parameters

    • tcpKeepAlive: boolean

    Returns HttpSenderOptions

setTcpNoDelay

  • Parameters

    • tcpNoDelay: boolean

    Returns HttpSenderOptions

setTcpQuickAck

  • Parameters

    • tcpQuickAck: boolean

    Returns HttpSenderOptions

setTcpUserTimeout

  • Parameters

    • tcpUserTimeout: number

    Returns HttpSenderOptions

setTracingPolicy

  • Parameters

    • tracingPolicy: TracingPolicy

    Returns HttpSenderOptions

setTrafficClass

  • Parameters

    • trafficClass: number

    Returns HttpSenderOptions

setTrustAll

  • Parameters

    • trustAll: boolean

    Returns HttpSenderOptions

setTrustOptions

  • Parameters

    • trustOptions: any

    Returns HttpSenderOptions

setTrustStoreOptions

  • Parameters

    • trustStoreOptions: JksOptions

    Returns HttpSenderOptions

setTryUseCompression

  • Parameters

    • tryUseCompression: boolean

    Returns HttpSenderOptions

setTryUsePerFrameWebSocketCompression

  • setTryUsePerFrameWebSocketCompression(tryUsePerFrameWebSocketCompression: boolean): HttpSenderOptions
  • Parameters

    • tryUsePerFrameWebSocketCompression: boolean

    Returns HttpSenderOptions

setTryUsePerMessageWebSocketCompression

  • setTryUsePerMessageWebSocketCompression(tryUsePerMessageWebSocketCompression: boolean): HttpSenderOptions
  • Parameters

    • tryUsePerMessageWebSocketCompression: boolean

    Returns HttpSenderOptions

setUseAlpn

  • Parameters

    • useAlpn: boolean

    Returns HttpSenderOptions

setVerifyHost

  • Parameters

    • verifyHost: boolean

    Returns HttpSenderOptions

setWebSocketClosingTimeout

  • Parameters

    • webSocketClosingTimeout: number

    Returns HttpSenderOptions

setWebSocketCompressionAllowClientNoContext

  • setWebSocketCompressionAllowClientNoContext(webSocketCompressionAllowClientNoContext: boolean): HttpSenderOptions
  • Parameters

    • webSocketCompressionAllowClientNoContext: boolean

    Returns HttpSenderOptions

setWebSocketCompressionLevel

  • Parameters

    • webSocketCompressionLevel: number

    Returns HttpSenderOptions

setWebSocketCompressionRequestServerNoContext

  • setWebSocketCompressionRequestServerNoContext(webSocketCompressionRequestServerNoContext: boolean): HttpSenderOptions
  • Parameters

    • webSocketCompressionRequestServerNoContext: boolean

    Returns HttpSenderOptions

setWriteIdleTimeout

  • Parameters

    • writeIdleTimeout: number

    Returns HttpSenderOptions

toJson

  • toJson(): {}
  • Returns {}

    • [key: string]: any

Generated using TypeDoc