Values | |
clientOptionsBase | shared clientOptionsBase clientOptionsBase |
jksOptions | shared jksOptions jksOptions |
keyCertOptions | shared keyCertOptions keyCertOptions |
netClientOptions | shared netClientOptions netClientOptions |
netServerOptions | shared netServerOptions netServerOptions |
networkOptions | shared networkOptions networkOptions |
pemKeyCertOptions | shared pemKeyCertOptions pemKeyCertOptions |
pemTrustOptions | shared pemTrustOptions pemTrustOptions |
pfxOptions | shared pfxOptions pfxOptions |
tcpsslOptions | shared tcpsslOptions tcpsslOptions |
trustOptions | shared trustOptions trustOptions |
Interfaces | |
KeyCertOptions | shared KeyCertOptions |
TrustOptions | shared TrustOptions |
Classes | |
ClientOptionsBase | shared ClientOptionsBase Base class for Client options |
JksOptions | shared JksOptions Key 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(JKSOptions.options().setPath("/mykeystore.jks").setPassword("foo")); Or directly provided as a buffer: Buffer store = vertx.fileSystem().readFileSync("/mykeystore.jks"); options.setKeyStore(JKSOptions.options().setValue(store).setPassword("foo")); |
NetClient | shared NetClient A 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 NetClientOptions Options for configuring a NetClient. |
NetServer | shared NetServer Represents a TCP server |
NetServerOptions | shared NetServerOptions Options for configuring a NetServer. |
NetSocket | shared NetSocket Represents 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 NetSocketStream A ReadStream of NetSocket, used for notifying socket connections to a NetServer. |
NetworkOptions | shared NetworkOptions @author Tim Fox |
PemKeyCertOptions | shared PemKeyCertOptions Key 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 PemTrustOptions Certificate 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 PfxOptions Key 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")); |
SocketAddress | shared SocketAddress The address of a socket |
TCPSSLOptions | shared TCPSSLOptions Base class. TCP and SSL related options |
clientOptionsBase | shared clientOptionsBase |
jksOptions | shared jksOptions |
keyCertOptions | shared keyCertOptions |
netClientOptions | shared netClientOptions |
netServerOptions | shared netServerOptions |
networkOptions | shared networkOptions |
pemKeyCertOptions | shared pemKeyCertOptions |
pemTrustOptions | shared pemTrustOptions |
pfxOptions | shared pfxOptions |
tcpsslOptions | shared tcpsslOptions |
trustOptions | shared trustOptions |