Class SSLOptions

SSL options

Hierarchy

SSLOptions

Index

Constructors

constructor

Methods

Constructors

constructor

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

- Defined in generator/io.vertx/vertx-core/target/npm/options.d.ts:6209
Returns SSLOptions
- Defined in generator/io.vertx/vertx-core/target/npm/options.d.ts:6211
Parameters
- obj: SSLOptions | {}
Returns SSLOptions

Methods

addCrlPath

addCrlPath(crlPaths: string): SSLOptions

- Defined in generator/io.vertx/vertx-core/target/npm/options.d.ts:6223
Add a CRL path

Parameters
- crlPaths: string
Returns SSLOptions

addCrlValue

addCrlValue(crlValues: Buffer): SSLOptions

- Defined in generator/io.vertx/vertx-core/target/npm/options.d.ts:6233
Add a CRL value

Parameters
- crlValues: Buffer
Returns SSLOptions

addEnabledCipherSuite

addEnabledCipherSuite(enabledCipherSuites: string): SSLOptions

- Defined in generator/io.vertx/vertx-core/target/npm/options.d.ts:6243
Add an enabled cipher suite, appended to the ordered suites.

Parameters
- enabledCipherSuites: string
Returns SSLOptions

addEnabledSecureTransportProtocol

addEnabledSecureTransportProtocol(enabledSecureTransportProtocols: string): SSLOptions

- Defined in generator/io.vertx/vertx-core/target/npm/options.d.ts:6258
Sets the list of enabled SSL/TLS protocols.

Parameters
- enabledSecureTransportProtocols: string
Returns SSLOptions

getCrlPaths

getCrlPaths(): string[]

- Defined in generator/io.vertx/vertx-core/target/npm/options.d.ts:6218
Add a CRL path

Returns string[]

getCrlValues

getCrlValues(): Buffer[]

- Defined in generator/io.vertx/vertx-core/target/npm/options.d.ts:6228
Add a CRL value

Returns Buffer[]

getEnabledCipherSuites

getEnabledCipherSuites(): string[]

- Defined in generator/io.vertx/vertx-core/target/npm/options.d.ts:6238
Add an enabled cipher suite, appended to the ordered suites.

Returns string[]

getEnabledSecureTransportProtocols

getEnabledSecureTransportProtocols(): string[]

- Defined in generator/io.vertx/vertx-core/target/npm/options.d.ts:6248
Sets the list of enabled SSL/TLS protocols.

Returns string[]

getSslHandshakeTimeout

getSslHandshakeTimeout(): number

- Defined in generator/io.vertx/vertx-core/target/npm/options.d.ts:6263
Set the SSL handshake timeout, default time unit is seconds.

Returns number

getSslHandshakeTimeoutUnit

getSslHandshakeTimeoutUnit(): any

- Defined in generator/io.vertx/vertx-core/target/npm/options.d.ts:6273
Set the SSL handshake timeout unit. If not specified, default is seconds.

Returns any

getTrustOptions

getTrustOptions(): TrustOptions

- Defined in generator/io.vertx/vertx-core/target/npm/options.d.ts:6283
Set the trust options.

Returns TrustOptions

isUseAlpn

isUseAlpn(): boolean

- Defined in generator/io.vertx/vertx-core/target/npm/options.d.ts:6293
Set the ALPN usage.

Returns boolean

setEnabledSecureTransportProtocols

setEnabledSecureTransportProtocols(enabledSecureTransportProtocols: string[]): SSLOptions

- Defined in generator/io.vertx/vertx-core/target/npm/options.d.ts:6253
Sets the list of enabled SSL/TLS protocols.

Parameters
- enabledSecureTransportProtocols: string[]
Returns SSLOptions

setSslHandshakeTimeout

setSslHandshakeTimeout(sslHandshakeTimeout: number): SSLOptions

- Defined in generator/io.vertx/vertx-core/target/npm/options.d.ts:6268
Set the SSL handshake timeout, default time unit is seconds.

Parameters
- sslHandshakeTimeout: number
Returns SSLOptions

setSslHandshakeTimeoutUnit

setSslHandshakeTimeoutUnit(sslHandshakeTimeoutUnit: any): SSLOptions

- Defined in generator/io.vertx/vertx-core/target/npm/options.d.ts:6278
Set the SSL handshake timeout unit. If not specified, default is seconds.

Parameters
- sslHandshakeTimeoutUnit: any
Returns SSLOptions

setTrustOptions

setTrustOptions(trustOptions: TrustOptions): SSLOptions

- Defined in generator/io.vertx/vertx-core/target/npm/options.d.ts:6288
Set the trust options.

Parameters
- trustOptions: TrustOptions
Returns SSLOptions

setUseAlpn

setUseAlpn(useAlpn: boolean): SSLOptions

- Defined in generator/io.vertx/vertx-core/target/npm/options.d.ts:6298
Set the ALPN usage.

Parameters
- useAlpn: boolean
Returns SSLOptions

toJson

toJson(): {}

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

Generated using TypeDoc