| Values | |
clientOptionsBase | shared clientOptionsBase clientOptionsBase |
http | shared http httpHTTP CONNECT ssl proxy |
jdkSSLEngineOptions | shared jdkSSLEngineOptions jdkSSLEngineOptions |
jksOptions | shared jksOptions jksOptions |
netClientOptions | shared netClientOptions netClientOptions |
netServerOptions | shared netServerOptions netServerOptions |
networkOptions | shared networkOptions networkOptions |
openSSLEngineOptions | shared openSSLEngineOptions openSSLEngineOptions |
pemKeyCertOptions | shared pemKeyCertOptions pemKeyCertOptions |
pemTrustOptions | shared pemTrustOptions pemTrustOptions |
pfxOptions | shared pfxOptions pfxOptions |
proxyOptions | shared proxyOptions proxyOptions |
proxyType | shared proxyType proxyType |
socks4 | shared socks4 socks4SOCKS4/4a tcp proxy |
socks5 | shared socks5 socks5SOCSK5 tcp proxy |
tcpsslOptions | shared tcpsslOptions tcpsslOptions |
| Classes | |
ClientOptionsBase | shared ClientOptionsBaseBase class for Client options |
JdkSSLEngineOptions | shared JdkSSLEngineOptionsConfigures a TCPSSLOptions to use the JDK ssl engine implementation. |
JksOptions | shared JksOptionsKey or trust store options configuring private key and/or certificates based on Java Keystore files. When used as a key store, it should point to a store containing a private key and its certificate. When used as a trust store, it should point to a store containing a list of trusted certificates. The store can either be loaded by Vert.x from the filesystem:
HttpServerOptions options = HttpServerOptions.httpServerOptions();
options.setKeyStore(new JKSOptions().setPath("/mykeystore.jks").setPassword("foo"));
Or directly provided as a buffer:
Buffer store = vertx.fileSystem().readFileSync("/mykeystore.jks");
options.setKeyStore(new JKSOptions().setValue(store).setPassword("foo"));
|
NetClient | shared NetClientA TCP client. Multiple connections to different servers can be made using the same instance. This client supports a configurable number of connection attempts and a configurable delay between attempts. |
NetClientOptions | shared NetClientOptionsOptions for configuring a NetClient. |
NetServer | shared NetServerRepresents a TCP server |
NetServerOptions | shared NetServerOptionsOptions for configuring a NetServer. |
NetSocket | shared NetSocketRepresents a socket-like interface to a TCP connection on either the client or the server side. Instances of this class are created on the client side by an NetClient when a connection to a server is made, or on the server side by a NetServer when a server accepts a connection. It implements both and so it can be used with Pump to pump data with flow control. |
NetSocketStream | shared NetSocketStreamA ReadStream of NetSocket, used for notifying socket connections to a NetServer. |
NetworkOptions | shared NetworkOptions@author Tim Fox |
OpenSSLEngineOptions | shared OpenSSLEngineOptionsConfigures a TCPSSLOptions to use OpenSsl. |
PemKeyCertOptions | shared PemKeyCertOptionsKey store options configuring a private key and its certificate based on Privacy-enhanced Electronic Email (PEM) files. The key file must contain a non encrypted private key in PKCS8 format wrapped in a PEM block, for example: -----BEGIN PRIVATE KEY----- MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDV6zPk5WqLwS0a ... K5xBhtm1AhdnZjx5KfW3BecE -----END PRIVATE KEY-----
The certificate file must contain an X.509 certificate wrapped in a PEM block, for example: -----BEGIN CERTIFICATE----- MIIDezCCAmOgAwIBAgIEZOI/3TANBgkqhkiG9w0BAQsFADBuMRAwDgYDVQQGEwdV ... +tmLSvYS39O2nqIzzAUfztkYnUlZmB0l/mKkVqbGJA== -----END CERTIFICATE----- The key and certificate can either be loaded by Vert.x from the filesystem:
HttpServerOptions options = new HttpServerOptions();
options.setPemKeyCertOptions(new PemKeyCertOptions().setKeyPath("/mykey.pem").setCertPath("/mycert.pem"));
Or directly provided as a buffer:
Buffer key = vertx.fileSystem().readFileSync("/mykey.pem");
Buffer cert = vertx.fileSystem().readFileSync("/mycert.pem");
options.setPemKeyCertOptions(new PemKeyCertOptions().setKeyValue(key).setCertValue(cert));
|
PemTrustOptions | shared PemTrustOptionsCertificate Authority options configuring certificates based on Privacy-enhanced Electronic Email (PEM) files. The options is configured with a list of validating certificates. Validating certificates must contain X.509 certificates wrapped in a PEM block: -----BEGIN CERTIFICATE----- MIIDezCCAmOgAwIBAgIEVmLkwTANBgkqhkiG9w0BAQsFADBuMRAwDgYDVQQGEwdV ... z5+DuODBJUQst141Jmgq8bS543IU/5apcKQeGNxEyQ== -----END CERTIFICATE----- The certificates can either be loaded by Vert.x from the filesystem:
HttpServerOptions options = new HttpServerOptions();
options.setPemTrustOptions(new PemTrustOptions().addCertPath("/cert.pem"));
Or directly provided as a buffer:
Buffer cert = vertx.fileSystem().readFileSync("/cert.pem");
HttpServerOptions options = new HttpServerOptions();
options.setPemTrustOptions(new PemTrustOptions().addCertValue(cert));
|
PfxOptions | shared PfxOptionsKey or trust store options configuring private key and/or certificates based on PKCS#12 files. When used as a key store, it should point to a store containing a private key and its certificate. When used as a trust store, it should point to a store containing a list of accepted certificates. The store can either be loaded by Vert.x from the filesystem:
HttpServerOptions options = new HttpServerOptions();
options.setPfxKeyCertOptions(new PfxOptions().setPath("/mykeystore.p12").setPassword("foo"));
Or directly provided as a buffer:
Buffer store = vertx.fileSystem().readFileSync("/mykeystore.p12");
options.setPfxKeyCertOptions(new PfxOptions().setValue(store).setPassword("foo"));
|
ProxyOptions | shared ProxyOptionsProxy options for a net client or a net client. |
ProxyType | shared abstract ProxyTypeThe type of a TCP proxy server. |
SocketAddress | shared SocketAddressThe address of a socket |
TCPSSLOptions | shared TCPSSLOptionsBase class. TCP and SSL related options |
clientOptionsBase | shared clientOptionsBase |
http | shared httpHTTP CONNECT ssl proxy |
jdkSSLEngineOptions | shared jdkSSLEngineOptions |
jksOptions | shared jksOptions |
netClientOptions | shared netClientOptions |
netServerOptions | shared netServerOptions |
networkOptions | shared networkOptions |
openSSLEngineOptions | shared openSSLEngineOptions |
pemKeyCertOptions | shared pemKeyCertOptions |
pemTrustOptions | shared pemTrustOptions |
pfxOptions | shared pfxOptions |
proxyOptions | shared proxyOptions |
proxyType | shared proxyType |
socks4 | shared socks4SOCKS4/4a tcp proxy |
socks5 | shared socks5SOCSK5 tcp proxy |
tcpsslOptions | shared tcpsslOptions |