Class ProtonServerOptions

Options for configuring {@link ProtonServer} creation.

Hierarchy

any
- ProtonServerOptions

Index

Constructors

constructor

Methods

Constructors

constructor

new ProtonServerOptions(): ProtonServerOptions
new ProtonServerOptions(obj: ProtonServerOptions | {}): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:355
Returns ProtonServerOptions
- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:357
Parameters
- obj: ProtonServerOptions | {}
Returns ProtonServerOptions

Methods

addCrlPath

addCrlPath(crlPaths: string): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:375
Parameters
- crlPaths: string
Returns ProtonServerOptions

addCrlValue

addCrlValue(crlValues: Buffer): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:379
Parameters
- crlValues: Buffer
Returns ProtonServerOptions

addEnabledCipherSuite

addEnabledCipherSuite(enabledCipherSuites: string): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:383
Parameters
- enabledCipherSuites: string
Returns ProtonServerOptions

addEnabledSecureTransportProtocol

addEnabledSecureTransportProtocol(enabledSecureTransportProtocols: string): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:389
Parameters
- enabledSecureTransportProtocols: string
Returns ProtonServerOptions

getAcceptBacklog

getAcceptBacklog(): number

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:361
Returns number

getActivityLogDataFormat

getActivityLogDataFormat(): any

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:365
Returns any

getClientAuth

getClientAuth(): ClientAuth

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:369
Returns ClientAuth

getCrlPaths

getCrlPaths(): string[]

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:373
Returns string[]

getCrlValues

getCrlValues(): Buffer[]

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:377
Returns Buffer[]

getEnabledCipherSuites

getEnabledCipherSuites(): string[]

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:381
Returns string[]

getEnabledSecureTransportProtocols

getEnabledSecureTransportProtocols(): string[]

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:385
Returns string[]

getHeartbeat

getHeartbeat(): number

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:395
Sets the heart beat (in milliseconds) as maximum delay between sending frames for the remote peers. If no frames are received within 2 * heart beat, the connection is closed.

Returns number

getHost

getHost(): string

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:403
Returns string

getIdleTimeout

getIdleTimeout(): number

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:407
Returns number

getIdleTimeoutUnit

getIdleTimeoutUnit(): any

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:411
Returns any

getJdkSslEngineOptions

getJdkSslEngineOptions(): JdkSSLEngineOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:415
Returns JdkSSLEngineOptions

getKeyStoreOptions

getKeyStoreOptions(): JksOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:421
Returns JksOptions

getLogActivity

getLogActivity(): boolean

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:425
Returns boolean

getMaxFrameSize

getMaxFrameSize(): number

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:436
Sets the maximum frame size for connections.

If this property is not set explicitly, a reasonable default value is used.
Setting this property to a negative value will result in no maximum frame size being announced at all.

Returns number

getOpenSslEngineOptions

getOpenSslEngineOptions(): OpenSSLEngineOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:447
Returns OpenSSLEngineOptions

getPemKeyCertOptions

getPemKeyCertOptions(): PemKeyCertOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:451
Returns PemKeyCertOptions

getPemTrustOptions

getPemTrustOptions(): PemTrustOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:455
Returns PemTrustOptions

getPfxKeyCertOptions

getPfxKeyCertOptions(): PfxOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:459
Returns PfxOptions

getPfxTrustOptions

getPfxTrustOptions(): PfxOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:463
Returns PfxOptions

getPort

getPort(): number

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:467
Returns number

getProxyProtocolTimeout

getProxyProtocolTimeout(): number

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:471
Returns number

getProxyProtocolTimeoutUnit

getProxyProtocolTimeoutUnit(): any

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:475
Returns any

getReadIdleTimeout

getReadIdleTimeout(): number

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:479
Returns number

getReceiveBufferSize

getReceiveBufferSize(): number

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:483
Returns number

getSendBufferSize

getSendBufferSize(): number

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:499
Returns number

getSoLinger

getSoLinger(): number

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:507
Returns number

getSslEngineOptions

getSslEngineOptions(): any

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:515
Returns any

getSslHandshakeTimeout

getSslHandshakeTimeout(): number

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:519
Returns number

getSslHandshakeTimeoutUnit

getSslHandshakeTimeoutUnit(): any

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:523
Returns any

getTcpUserTimeout

getTcpUserTimeout(): number

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:547
Returns number

getTrafficClass

getTrafficClass(): number

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:551
Returns number

getTrustOptions

getTrustOptions(): any

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:555
Returns any

getTrustStoreOptions

getTrustStoreOptions(): JksOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:559
Returns JksOptions

getWriteIdleTimeout

getWriteIdleTimeout(): number

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:571
Returns number

isRegisterWriteHandler

isRegisterWriteHandler(): boolean

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:487
Returns boolean

isReuseAddress

isReuseAddress(): boolean

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:491
Returns boolean

isReusePort

isReusePort(): boolean

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:495
Returns boolean

isSni

isSni(): boolean

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:503
Returns boolean

isSsl

isSsl(): boolean

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:511
Returns boolean

isTcpCork

isTcpCork(): boolean

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:527
Returns boolean

isTcpFastOpen

isTcpFastOpen(): boolean

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:531
Returns boolean

isTcpKeepAlive

isTcpKeepAlive(): boolean

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:535
Returns boolean

isTcpNoDelay

isTcpNoDelay(): boolean

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:539
Returns boolean

isTcpQuickAck

isTcpQuickAck(): boolean

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:543
Returns boolean

isUseAlpn

isUseAlpn(): boolean

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:563
Returns boolean

isUseProxyProtocol

isUseProxyProtocol(): boolean

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:567
Returns boolean

setAcceptBacklog

setAcceptBacklog(acceptBacklog: number): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:363
Parameters
- acceptBacklog: number
Returns ProtonServerOptions

setActivityLogDataFormat

setActivityLogDataFormat(activityLogDataFormat: any): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:367
Parameters
- activityLogDataFormat: any
Returns ProtonServerOptions

setClientAuth

setClientAuth(clientAuth: ClientAuth): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:371
Parameters
- clientAuth: ClientAuth
Returns ProtonServerOptions

setEnabledSecureTransportProtocols

setEnabledSecureTransportProtocols(enabledSecureTransportProtocols: string[]): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:387
Parameters
- enabledSecureTransportProtocols: string[]
Returns ProtonServerOptions

setHeartbeat

setHeartbeat(heartbeat: number): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:401
Sets the heart beat (in milliseconds) as maximum delay between sending frames for the remote peers. If no frames are received within 2 * heart beat, the connection is closed.

Parameters
- heartbeat: number
Returns ProtonServerOptions

setHost

setHost(host: string): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:405
Parameters
- host: string
Returns ProtonServerOptions

setIdleTimeout

setIdleTimeout(idleTimeout: number): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:409
Parameters
- idleTimeout: number
Returns ProtonServerOptions

setIdleTimeoutUnit

setIdleTimeoutUnit(idleTimeoutUnit: any): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:413
Parameters
- idleTimeoutUnit: any
Returns ProtonServerOptions

setJdkSslEngineOptions

setJdkSslEngineOptions(jdkSslEngineOptions: JdkSSLEngineOptions): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:417
Parameters
- jdkSslEngineOptions: JdkSSLEngineOptions
Returns ProtonServerOptions

setKeyCertOptions

setKeyCertOptions(keyCertOptions: any): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:419
Parameters
- keyCertOptions: any
Returns ProtonServerOptions

setKeyStoreOptions

setKeyStoreOptions(keyStoreOptions: JksOptions): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:423
Parameters
- keyStoreOptions: JksOptions
Returns ProtonServerOptions

setLogActivity

setLogActivity(logActivity: boolean): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:427
Parameters
- logActivity: boolean
Returns ProtonServerOptions

setMaxFrameSize

setMaxFrameSize(maxFrameSize: number): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:445
Sets the maximum frame size for connections.

If this property is not set explicitly, a reasonable default value is used.
Setting this property to a negative value will result in no maximum frame size being announced at all.

Parameters
- maxFrameSize: number
Returns ProtonServerOptions

setOpenSslEngineOptions

setOpenSslEngineOptions(openSslEngineOptions: OpenSSLEngineOptions): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:449
Parameters
- openSslEngineOptions: OpenSSLEngineOptions
Returns ProtonServerOptions

setPemKeyCertOptions

setPemKeyCertOptions(pemKeyCertOptions: PemKeyCertOptions): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:453
Parameters
- pemKeyCertOptions: PemKeyCertOptions
Returns ProtonServerOptions

setPemTrustOptions

setPemTrustOptions(pemTrustOptions: PemTrustOptions): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:457
Parameters
- pemTrustOptions: PemTrustOptions
Returns ProtonServerOptions

setPfxKeyCertOptions

setPfxKeyCertOptions(pfxKeyCertOptions: PfxOptions): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:461
Parameters
- pfxKeyCertOptions: PfxOptions
Returns ProtonServerOptions

setPfxTrustOptions

setPfxTrustOptions(pfxTrustOptions: PfxOptions): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:465
Parameters
- pfxTrustOptions: PfxOptions
Returns ProtonServerOptions

setPort

setPort(port: number): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:469
Parameters
- port: number
Returns ProtonServerOptions

setProxyProtocolTimeout

setProxyProtocolTimeout(proxyProtocolTimeout: number): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:473
Parameters
- proxyProtocolTimeout: number
Returns ProtonServerOptions

setProxyProtocolTimeoutUnit

setProxyProtocolTimeoutUnit(proxyProtocolTimeoutUnit: any): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:477
Parameters
- proxyProtocolTimeoutUnit: any
Returns ProtonServerOptions

setReadIdleTimeout

setReadIdleTimeout(readIdleTimeout: number): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:481
Parameters
- readIdleTimeout: number
Returns ProtonServerOptions

setReceiveBufferSize

setReceiveBufferSize(receiveBufferSize: number): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:485
Parameters
- receiveBufferSize: number
Returns ProtonServerOptions

setRegisterWriteHandler

setRegisterWriteHandler(registerWriteHandler: boolean): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:489
Parameters
- registerWriteHandler: boolean
Returns ProtonServerOptions

setReuseAddress

setReuseAddress(reuseAddress: boolean): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:493
Parameters
- reuseAddress: boolean
Returns ProtonServerOptions

setReusePort

setReusePort(reusePort: boolean): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:497
Parameters
- reusePort: boolean
Returns ProtonServerOptions

setSendBufferSize

setSendBufferSize(sendBufferSize: number): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:501
Parameters
- sendBufferSize: number
Returns ProtonServerOptions

setSni

setSni(sni: boolean): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:505
Parameters
- sni: boolean
Returns ProtonServerOptions

setSoLinger

setSoLinger(soLinger: number): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:509
Parameters
- soLinger: number
Returns ProtonServerOptions

setSsl

setSsl(ssl: boolean): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:513
Parameters
- ssl: boolean
Returns ProtonServerOptions

setSslEngineOptions

setSslEngineOptions(sslEngineOptions: any): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:517
Parameters
- sslEngineOptions: any
Returns ProtonServerOptions

setSslHandshakeTimeout

setSslHandshakeTimeout(sslHandshakeTimeout: number): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:521
Parameters
- sslHandshakeTimeout: number
Returns ProtonServerOptions

setSslHandshakeTimeoutUnit

setSslHandshakeTimeoutUnit(sslHandshakeTimeoutUnit: any): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:525
Parameters
- sslHandshakeTimeoutUnit: any
Returns ProtonServerOptions

setTcpCork

setTcpCork(tcpCork: boolean): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:529
Parameters
- tcpCork: boolean
Returns ProtonServerOptions

setTcpFastOpen

setTcpFastOpen(tcpFastOpen: boolean): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:533
Parameters
- tcpFastOpen: boolean
Returns ProtonServerOptions

setTcpKeepAlive

setTcpKeepAlive(tcpKeepAlive: boolean): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:537
Parameters
- tcpKeepAlive: boolean
Returns ProtonServerOptions

setTcpNoDelay

setTcpNoDelay(tcpNoDelay: boolean): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:541
Parameters
- tcpNoDelay: boolean
Returns ProtonServerOptions

setTcpQuickAck

setTcpQuickAck(tcpQuickAck: boolean): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:545
Parameters
- tcpQuickAck: boolean
Returns ProtonServerOptions

setTcpUserTimeout

setTcpUserTimeout(tcpUserTimeout: number): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:549
Parameters
- tcpUserTimeout: number
Returns ProtonServerOptions

setTrafficClass

setTrafficClass(trafficClass: number): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:553
Parameters
- trafficClass: number
Returns ProtonServerOptions

setTrustOptions

setTrustOptions(trustOptions: any): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:557
Parameters
- trustOptions: any
Returns ProtonServerOptions

setTrustStoreOptions

setTrustStoreOptions(trustStoreOptions: JksOptions): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:561
Parameters
- trustStoreOptions: JksOptions
Returns ProtonServerOptions

setUseAlpn

setUseAlpn(useAlpn: boolean): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:565
Parameters
- useAlpn: boolean
Returns ProtonServerOptions

setUseProxyProtocol

setUseProxyProtocol(useProxyProtocol: boolean): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:569
Parameters
- useProxyProtocol: boolean
Returns ProtonServerOptions

setWriteIdleTimeout

setWriteIdleTimeout(writeIdleTimeout: number): ProtonServerOptions

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:573
Parameters
- writeIdleTimeout: number
Returns ProtonServerOptions

toJson

toJson(): {}

- Defined in io.vertx/vertx-proton/target/npm/options.d.ts:576
Returns {}
- [key: string]: any

Generated using TypeDoc