= Cheatsheets

[[HttpTermOptions]]
== HttpTermOptions

++++
 The web term configuration options.
++++
'''

[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[acceptBacklog]]`acceptBacklog`|`Number (int)`|-
|[[alpnVersions]]`alpnVersions`|`Array of link:enums.html#HttpVersion[HttpVersion]`|-
|[[authOptions]]`authOptions`|`link:dataobjects.html#AuthOptions[AuthOptions]`|
+++
@return the auth options
+++
|[[charset]]`charset`|`String`|
+++
Set the charset used for encoding / decoding text data from/to SockJS
+++
|[[clientAuth]]`clientAuth`|`link:enums.html#ClientAuth[ClientAuth]`|-
|[[clientAuthRequired]]`clientAuthRequired`|`Boolean`|-
|[[compressionSupported]]`compressionSupported`|`Boolean`|-
|[[crlPaths]]`crlPaths`|`Array of String`|-
|[[crlValues]]`crlValues`|`Array of Buffer`|-
|[[enabledCipherSuites]]`enabledCipherSuites`|`Array of String`|-
|[[enabledSecureTransportProtocols]]`enabledSecureTransportProtocols`|`Array of String`|-
|[[handle100ContinueAutomatically]]`handle100ContinueAutomatically`|`Boolean`|-
|[[host]]`host`|`String`|-
|[[http2ConnectionWindowSize]]`http2ConnectionWindowSize`|`Number (int)`|-
|[[idleTimeout]]`idleTimeout`|`Number (int)`|-
|[[initialSettings]]`initialSettings`|`link:dataobjects.html#Http2Settings[Http2Settings]`|-
|[[intputrc]]`intputrc`|`String`|
+++
The path of the <i>inputrc</i> config.
+++
|[[jdkSslEngineOptions]]`jdkSslEngineOptions`|`link:dataobjects.html#JdkSSLEngineOptions[JdkSSLEngineOptions]`|-
|[[keyStoreOptions]]`keyStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|-
|[[logActivity]]`logActivity`|`Boolean`|-
|[[maxChunkSize]]`maxChunkSize`|`Number (int)`|-
|[[maxHeaderSize]]`maxHeaderSize`|`Number (int)`|-
|[[maxInitialLineLength]]`maxInitialLineLength`|`Number (int)`|-
|[[maxWebsocketFrameSize]]`maxWebsocketFrameSize`|`Number (int)`|-
|[[openSslEngineOptions]]`openSslEngineOptions`|`link:dataobjects.html#OpenSSLEngineOptions[OpenSSLEngineOptions]`|-
|[[pemKeyCertOptions]]`pemKeyCertOptions`|`link:dataobjects.html#PemKeyCertOptions[PemKeyCertOptions]`|-
|[[pemTrustOptions]]`pemTrustOptions`|`link:dataobjects.html#PemTrustOptions[PemTrustOptions]`|-
|[[pfxKeyCertOptions]]`pfxKeyCertOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|-
|[[pfxTrustOptions]]`pfxTrustOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|-
|[[port]]`port`|`Number (int)`|-
|[[receiveBufferSize]]`receiveBufferSize`|`Number (int)`|-
|[[reuseAddress]]`reuseAddress`|`Boolean`|-
|[[sendBufferSize]]`sendBufferSize`|`Number (int)`|-
|[[shellHtmlResource]]`shellHtmlResource`|`Buffer`|
+++
Set <code>shell.html</code> resource to use.
+++
|[[soLinger]]`soLinger`|`Number (int)`|-
|[[sockJSHandlerOptions]]`sockJSHandlerOptions`|`link:dataobjects.html#SockJSHandlerOptions[SockJSHandlerOptions]`|
+++
The SockJS handler options.
+++
|[[sockJSPath]]`sockJSPath`|`String`|
+++
Configure the SockJS path, the default value is <code>/term/*</code>.
+++
|[[ssl]]`ssl`|`Boolean`|-
|[[tcpKeepAlive]]`tcpKeepAlive`|`Boolean`|-
|[[tcpNoDelay]]`tcpNoDelay`|`Boolean`|-
|[[termJsResource]]`termJsResource`|`Buffer`|
+++
Set <code>term.js</code> resource to use.
+++
|[[trafficClass]]`trafficClass`|`Number (int)`|-
|[[trustStoreOptions]]`trustStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|-
|[[useAlpn]]`useAlpn`|`Boolean`|-
|[[usePooledBuffers]]`usePooledBuffers`|`Boolean`|-
|[[vertsShellJsResource]]`vertsShellJsResource`|`Buffer`|
+++
Set <code>vertxshell.js</code> resource to use.
+++
|[[websocketSubProtocols]]`websocketSubProtocols`|`String`|-
|===

[[SSHTermOptions]]
== SSHTermOptions

++++
 The SSH term configuration options.
++++
'''

[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[authOptions]]`authOptions`|`link:dataobjects.html#AuthOptions[AuthOptions]`|
+++
@return the auth options
+++
|[[defaultCharset]]`defaultCharset`|`String`|
+++
Set the default charset to use when the client does not specifies one.
+++
|[[host]]`host`|`String`|
+++
Set the host
+++
|[[intputrc]]`intputrc`|`String`|
+++
The path of the <i>inputrc</i> config.
+++
|[[keyPairOptions]]`keyPairOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|
+++
Set the key pair options in jks format, aka Java keystore.
+++
|[[pemKeyPairOptions]]`pemKeyPairOptions`|`link:dataobjects.html#PemKeyCertOptions[PemKeyCertOptions]`|
+++
Set the key pair store options in pem format.
+++
|[[pfxKeyPairOptions]]`pfxKeyPairOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|
+++
Set the key pair options in pfx format.
+++
|[[port]]`port`|`Number (int)`|
+++
Set the port
+++
|===

[[ShellServerOptions]]
== ShellServerOptions

++++
 The configurations options for the shell server.
++++
'''

[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[reaperInterval]]`reaperInterval`|`Number (long)`|
+++
Set the repear interval, i.e the period at which session eviction is performed.
+++
|[[sessionTimeout]]`sessionTimeout`|`Number (long)`|
+++
Set the session timeout.
+++
|[[welcomeMessage]]`welcomeMessage`|`String`|
+++
Set the shell welcome message, i.e the message displayed in the user console when he connects to the shell.
+++
|===

[[ShellServiceOptions]]
== ShellServiceOptions

++++
 The configurations options for the shell service, the shell connectors can be configured
 with ,  and .
++++
'''

[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[httpOptions]]`httpOptions`|`link:dataobjects.html#HttpTermOptions[HttpTermOptions]`|-
|[[reaperInterval]]`reaperInterval`|`Number (long)`|
+++
Set the repear interval, i.e the period at which session eviction is performed.
+++
|[[sessionTimeout]]`sessionTimeout`|`Number (long)`|
+++
Set the session timeout.
+++
|[[sshOptions]]`sshOptions`|`link:dataobjects.html#SSHTermOptions[SSHTermOptions]`|
+++
Set the SSH options, if the option is null, SSH will not be started.
+++
|[[telnetOptions]]`telnetOptions`|`link:dataobjects.html#TelnetTermOptions[TelnetTermOptions]`|
+++
Set the Telnet options, if the option is null, Telnet will not be started.
+++
|[[welcomeMessage]]`welcomeMessage`|`String`|
+++
Set the shell welcome message, i.e the message displayed in the user console when he connects to the shell.
+++
|===

[[TelnetTermOptions]]
== TelnetTermOptions

++++
 Telnet terminal options configuration, extends link.
++++
'''

[cols=">25%,^25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[acceptBacklog]]`acceptBacklog`|`Number (int)`|-
|[[charset]]`charset`|`String`|
+++
Set the charset to use when binary mode is active, see link and link.
+++
|[[clientAuth]]`clientAuth`|`link:enums.html#ClientAuth[ClientAuth]`|-
|[[clientAuthRequired]]`clientAuthRequired`|`Boolean`|-
|[[crlPaths]]`crlPaths`|`Array of String`|-
|[[crlValues]]`crlValues`|`Array of Buffer`|-
|[[enabledCipherSuites]]`enabledCipherSuites`|`Array of String`|-
|[[enabledSecureTransportProtocols]]`enabledSecureTransportProtocols`|`Array of String`|-
|[[host]]`host`|`String`|-
|[[idleTimeout]]`idleTimeout`|`Number (int)`|-
|[[inBinary]]`inBinary`|`Boolean`|
+++
Set the telnet connection to negociate binary data format when receiving from the client, the default value is true. This
 allows to send data in 8 bit format and thus charset like UTF-8.
+++
|[[intputrc]]`intputrc`|`String`|
+++
The path of the <i>inputrc</i> config.
+++
|[[jdkSslEngineOptions]]`jdkSslEngineOptions`|`link:dataobjects.html#JdkSSLEngineOptions[JdkSSLEngineOptions]`|-
|[[keyStoreOptions]]`keyStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|-
|[[logActivity]]`logActivity`|`Boolean`|-
|[[openSslEngineOptions]]`openSslEngineOptions`|`link:dataobjects.html#OpenSSLEngineOptions[OpenSSLEngineOptions]`|-
|[[outBinary]]`outBinary`|`Boolean`|
+++
Set the telnet connection to negociate binary data format when sending to the client, the default value is true. This
 allows to send data in 8 bit format and thus charset like UTF-8.
+++
|[[pemKeyCertOptions]]`pemKeyCertOptions`|`link:dataobjects.html#PemKeyCertOptions[PemKeyCertOptions]`|-
|[[pemTrustOptions]]`pemTrustOptions`|`link:dataobjects.html#PemTrustOptions[PemTrustOptions]`|-
|[[pfxKeyCertOptions]]`pfxKeyCertOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|-
|[[pfxTrustOptions]]`pfxTrustOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|-
|[[port]]`port`|`Number (int)`|-
|[[receiveBufferSize]]`receiveBufferSize`|`Number (int)`|-
|[[reuseAddress]]`reuseAddress`|`Boolean`|-
|[[sendBufferSize]]`sendBufferSize`|`Number (int)`|-
|[[soLinger]]`soLinger`|`Number (int)`|-
|[[ssl]]`ssl`|`Boolean`|-
|[[tcpKeepAlive]]`tcpKeepAlive`|`Boolean`|-
|[[tcpNoDelay]]`tcpNoDelay`|`Boolean`|-
|[[trafficClass]]`trafficClass`|`Number (int)`|-
|[[trustStoreOptions]]`trustStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|-
|[[useAlpn]]`useAlpn`|`Boolean`|-
|[[usePooledBuffers]]`usePooledBuffers`|`Boolean`|-
|===

