Package | Description |
---|---|
io.vertx.core |
= Vert.x Core Manual
:toc: left
At the heart of Vert.x is a set of Java APIs that we call *Vert.x Core*
https://github.com/eclipse/vert.x[Repository].
|
io.vertx.core.eventbus |
== The Event Bus
:toc: left
The
event bus is the *nervous system* of Vert.x. |
io.vertx.core.http |
== Writing HTTP servers and clients
Vert.x allows you to easily write non blocking HTTP clients and servers.
|
Modifier and Type | Method and Description |
---|---|
MultiMap |
MultiMap.add(CharSequence name,
CharSequence value)
Like
add(String, String) but accepting CharSequence as parameters |
MultiMap |
MultiMap.add(CharSequence name,
Iterable<CharSequence> values)
Like
add(String, Iterable) but accepting CharSequence as parameters |
MultiMap |
MultiMap.add(String name,
Iterable<String> values)
Adds a new values under the specified name
|
MultiMap |
MultiMap.add(String name,
String value)
Adds a new value with the specified name and value.
|
MultiMap |
MultiMap.addAll(Map<String,String> headers)
Adds all the entries from a Map to this
|
MultiMap |
MultiMap.addAll(MultiMap map)
Adds all the entries from another MultiMap to this one
|
static MultiMap |
MultiMap.caseInsensitiveMultiMap()
Create a multi-map implementation with case insensitive keys, for instance it can be used to hold some HTTP headers.
|
MultiMap |
MultiMap.clear()
Removes all
|
MultiMap |
MultiMap.remove(CharSequence name)
Like
remove(String) but accepting CharSequence as parameters |
MultiMap |
MultiMap.remove(String name)
Removes the value with the given name
|
MultiMap |
MultiMap.set(CharSequence name,
CharSequence value)
Like
set(String, String) but accepting CharSequence as parameters |
MultiMap |
MultiMap.set(CharSequence name,
Iterable<CharSequence> values)
Like
set(String, Iterable) but accepting CharSequence as parameters |
MultiMap |
MultiMap.set(String name,
Iterable<String> values)
Sets values for the specified name.
|
MultiMap |
MultiMap.set(String name,
String value)
Sets a value under the specified name.
|
MultiMap |
MultiMap.setAll(Map<String,String> headers)
Cleans and set all values of the given instance
|
MultiMap |
MultiMap.setAll(MultiMap map)
Cleans this instance.
|
Modifier and Type | Method and Description |
---|---|
MultiMap |
MultiMap.addAll(MultiMap map)
Adds all the entries from another MultiMap to this one
|
MultiMap |
MultiMap.setAll(MultiMap map)
Cleans this instance.
|
Modifier and Type | Method and Description |
---|---|
MultiMap |
DeliveryOptions.getHeaders()
Get the message headers
|
MultiMap |
Message.headers()
Multi-map of message headers.
|
Modifier and Type | Method and Description |
---|---|
DeliveryOptions |
DeliveryOptions.setHeaders(MultiMap headers)
Set message headers from a multi-map.
|
Modifier and Type | Class and Description |
---|---|
class |
CaseInsensitiveHeaders
This multi-map implementation has case insensitive keys, and can be used to hold some HTTP headers
prior to making an HTTP request.
|
Modifier and Type | Method and Description |
---|---|
MultiMap |
CaseInsensitiveHeaders.add(CharSequence name,
CharSequence value) |
MultiMap |
CaseInsensitiveHeaders.add(CharSequence name,
Iterable<CharSequence> values) |
MultiMap |
CaseInsensitiveHeaders.add(String name,
Iterable<String> values) |
MultiMap |
CaseInsensitiveHeaders.add(String name,
String strVal) |
MultiMap |
CaseInsensitiveHeaders.addAll(Map<String,String> map) |
MultiMap |
CaseInsensitiveHeaders.addAll(MultiMap headers) |
MultiMap |
CaseInsensitiveHeaders.clear() |
MultiMap |
HttpServerRequest.formAttributes()
Returns a map of all form attributes in the request.
|
MultiMap |
ServerWebSocket.headers() |
MultiMap |
HttpServerResponse.headers() |
MultiMap |
HttpServerRequest.headers() |
MultiMap |
HttpClientResponse.headers() |
MultiMap |
HttpClientRequest.headers() |
MultiMap |
HttpServerRequest.params() |
MultiMap |
CaseInsensitiveHeaders.remove(CharSequence name) |
MultiMap |
CaseInsensitiveHeaders.remove(String name) |
MultiMap |
CaseInsensitiveHeaders.set(CharSequence name,
CharSequence value) |
MultiMap |
CaseInsensitiveHeaders.set(CharSequence name,
Iterable<CharSequence> values) |
MultiMap |
CaseInsensitiveHeaders.set(String name,
Iterable<String> values) |
MultiMap |
CaseInsensitiveHeaders.set(String name,
String strVal) |
MultiMap |
CaseInsensitiveHeaders.setAll(Map<String,String> headers) |
MultiMap |
CaseInsensitiveHeaders.setAll(MultiMap headers) |
MultiMap |
HttpServerResponse.trailers() |
MultiMap |
HttpClientResponse.trailers() |
Modifier and Type | Method and Description |
---|---|
MultiMap |
CaseInsensitiveHeaders.addAll(MultiMap headers) |
HttpServerResponse |
HttpServerResponse.push(HttpMethod method,
String path,
MultiMap headers,
Handler<AsyncResult<HttpServerResponse>> handler)
Like
HttpServerResponse.push(HttpMethod, String, String, MultiMap, Handler) with the host copied from the current request. |
HttpServerResponse |
HttpServerResponse.push(HttpMethod method,
String host,
String path,
MultiMap headers,
Handler<AsyncResult<HttpServerResponse>> handler)
Push a response to the client.
The
handler will be notified with a success when the push can be sent and with
a failure when the client has disabled push or reset the push before it has been sent.
The handler may be queued if the client has reduced the maximum number of streams the server can push
concurrently.
Push can be sent only for peer initiated streams and if the response is not ended. |
MultiMap |
CaseInsensitiveHeaders.setAll(MultiMap headers) |
HttpClient |
HttpClient.websocket(int port,
String host,
String requestURI,
MultiMap headers,
Handler<WebSocket> wsConnect)
Connect a WebSocket to the specified port, host and relative request URI, and with the specified headers
|
HttpClient |
HttpClient.websocket(int port,
String host,
String requestURI,
MultiMap headers,
Handler<WebSocket> wsConnect,
Handler<Throwable> failureHandler)
Connect a WebSocket to the specified port, host and relative request URI, and with the specified headers
|
HttpClient |
HttpClient.websocket(int port,
String host,
String requestURI,
MultiMap headers,
WebsocketVersion version,
Handler<WebSocket> wsConnect)
Connect a WebSocket to the specified port, host and relative request URI, with the specified headers and using
the specified version of WebSockets
|
HttpClient |
HttpClient.websocket(int port,
String host,
String requestURI,
MultiMap headers,
WebsocketVersion version,
Handler<WebSocket> wsConnect,
Handler<Throwable> failureHandler)
Connect a WebSocket to the specified port, host and relative request URI, with the specified headers and using
the specified version of WebSockets
|
HttpClient |
HttpClient.websocket(int port,
String host,
String requestURI,
MultiMap headers,
WebsocketVersion version,
String subProtocols,
Handler<WebSocket> wsConnect)
Connect a WebSocket to the specified port, host and relative request URI, with the specified headers, using
the specified version of WebSockets, and the specified websocket sub protocols
|
HttpClient |
HttpClient.websocket(int port,
String host,
String requestURI,
MultiMap headers,
WebsocketVersion version,
String subProtocols,
Handler<WebSocket> wsConnect,
Handler<Throwable> failureHandler)
Connect a WebSocket to the specified port, host and relative request URI, with the specified headers, using
the specified version of WebSockets, and the specified websocket sub protocols
|
HttpClient |
HttpClient.websocket(RequestOptions options,
MultiMap headers,
Handler<WebSocket> wsConnect)
Connect a WebSocket with the specified options, and with the specified headers
|
HttpClient |
HttpClient.websocket(RequestOptions options,
MultiMap headers,
Handler<WebSocket> wsConnect,
Handler<Throwable> failureHandler)
Connect a WebSocket with the specified options, and with the specified headers
|
HttpClient |
HttpClient.websocket(RequestOptions options,
MultiMap headers,
WebsocketVersion version,
Handler<WebSocket> wsConnect)
Connect a WebSocket with the specified optionsI, with the specified headers and using
the specified version of WebSockets
|
HttpClient |
HttpClient.websocket(RequestOptions options,
MultiMap headers,
WebsocketVersion version,
Handler<WebSocket> wsConnect,
Handler<Throwable> failureHandler)
Connect a WebSocket with the specified options, with the specified headers and using
the specified version of WebSockets
|
HttpClient |
HttpClient.websocket(RequestOptions options,
MultiMap headers,
WebsocketVersion version,
String subProtocols,
Handler<WebSocket> wsConnect)
Connect a WebSocket with the specified options, with the specified headers, using
the specified version of WebSockets, and the specified websocket sub protocols
|
HttpClient |
HttpClient.websocket(RequestOptions options,
MultiMap headers,
WebsocketVersion version,
String subProtocols,
Handler<WebSocket> wsConnect,
Handler<Throwable> failureHandler)
Connect a WebSocket with the specified options, with the specified headers, using
the specified version of WebSockets, and the specified websocket sub protocols
|
HttpClient |
HttpClient.websocket(String requestURI,
MultiMap headers,
Handler<WebSocket> wsConnect)
Connect a WebSocket at the relative request URI using the default host and port and the specified headers
|
HttpClient |
HttpClient.websocket(String requestURI,
MultiMap headers,
Handler<WebSocket> wsConnect,
Handler<Throwable> failureHandler)
Connect a WebSocket at the relative request URI using the default host and port and the specified headers
|
HttpClient |
HttpClient.websocket(String requestURI,
MultiMap headers,
WebsocketVersion version,
Handler<WebSocket> wsConnect)
Connect a WebSocket at the relative request URI using the default host and port, the specified headers and the
specified version of WebSockets
|
HttpClient |
HttpClient.websocket(String requestURI,
MultiMap headers,
WebsocketVersion version,
Handler<WebSocket> wsConnect,
Handler<Throwable> failureHandler)
Connect a WebSocket at the relative request URI using the default host and port, the specified headers and the
specified version of WebSockets
|
HttpClient |
HttpClient.websocket(String requestURI,
MultiMap headers,
WebsocketVersion version,
String subProtocols,
Handler<WebSocket> wsConnect)
Connect a WebSocket at the relative request URI using the default host and port, the specified headers, the
specified version of WebSockets and the specified sub protocols
|
HttpClient |
HttpClient.websocket(String requestURI,
MultiMap headers,
WebsocketVersion version,
String subProtocols,
Handler<WebSocket> wsConnect,
Handler<Throwable> failureHandler)
Connect a WebSocket at the relative request URI using the default host and port, the specified headers, the
specified version of WebSockets and the specified sub protocols
|
HttpClient |
HttpClient.websocket(String host,
String requestURI,
MultiMap headers,
Handler<WebSocket> wsConnect)
Connect a WebSocket to the specified host,relative request UR, and default port and with the specified headers
|
HttpClient |
HttpClient.websocket(String host,
String requestURI,
MultiMap headers,
Handler<WebSocket> wsConnect,
Handler<Throwable> failureHandler)
Connect a WebSocket to the specified host,relative request UR, and default port and with the specified headers
|
HttpClient |
HttpClient.websocket(String host,
String requestURI,
MultiMap headers,
WebsocketVersion version,
Handler<WebSocket> wsConnect)
Connect a WebSocket to the specified host, relative request URI and default port with the specified headers and using
the specified version of WebSockets
|
HttpClient |
HttpClient.websocket(String host,
String requestURI,
MultiMap headers,
WebsocketVersion version,
Handler<WebSocket> wsConnect,
Handler<Throwable> failureHandler)
Connect a WebSocket to the specified host, relative request URI and default port with the specified headers and using
the specified version of WebSockets
|
HttpClient |
HttpClient.websocket(String host,
String requestURI,
MultiMap headers,
WebsocketVersion version,
String subProtocols,
Handler<WebSocket> wsConnect)
Connect a WebSocket to the specified host, relative request URI and default port, with the specified headers, using
the specified version of WebSockets, and the specified websocket sub protocols
|
HttpClient |
HttpClient.websocket(String host,
String requestURI,
MultiMap headers,
WebsocketVersion version,
String subProtocols,
Handler<WebSocket> wsConnect,
Handler<Throwable> failureHandler)
Connect a WebSocket to the specified host, relative request URI and default port, with the specified headers, using
the specified version of WebSockets, and the specified websocket sub protocols
|
ReadStream<WebSocket> |
HttpClient.websocketStream(int port,
String host,
String requestURI,
MultiMap headers)
Create a WebSocket stream to the specified port, host and relative request URI, and with the specified headers
|
ReadStream<WebSocket> |
HttpClient.websocketStream(int port,
String host,
String requestURI,
MultiMap headers,
WebsocketVersion version)
Create a WebSocket stream to the specified port, host and relative request URI, with the specified headers and using
the specified version of WebSockets
|
ReadStream<WebSocket> |
HttpClient.websocketStream(int port,
String host,
String requestURI,
MultiMap headers,
WebsocketVersion version,
String subProtocols)
Create a WebSocket stream to the specified port, host and relative request URI, with the specified headers, using
the specified version of WebSockets, and the specified websocket sub protocols
|
ReadStream<WebSocket> |
HttpClient.websocketStream(RequestOptions options,
MultiMap headers)
Create a WebSocket stream with the specified options, and with the specified headers
|
ReadStream<WebSocket> |
HttpClient.websocketStream(RequestOptions options,
MultiMap headers,
WebsocketVersion version)
Create a WebSocket stream with the specified options, with the specified headers and using
the specified version of WebSockets
|
ReadStream<WebSocket> |
HttpClient.websocketStream(RequestOptions options,
MultiMap headers,
WebsocketVersion version,
String subProtocols)
Create a WebSocket stream to the specified port, host and relative request URI, with the specified headers, using
the specified version of WebSockets, and the specified websocket sub protocols
|
ReadStream<WebSocket> |
HttpClient.websocketStream(String requestURI,
MultiMap headers)
Create a WebSocket stream at the relative request URI using the default host and port and the specified headers
|
ReadStream<WebSocket> |
HttpClient.websocketStream(String requestURI,
MultiMap headers,
WebsocketVersion version)
Create a WebSocket stream at the relative request URI using the default host and port, the specified headers and the
specified version of WebSockets
|
ReadStream<WebSocket> |
HttpClient.websocketStream(String requestURI,
MultiMap headers,
WebsocketVersion version,
String subProtocols)
Create a WebSocket stream at the relative request URI using the default host and port, the specified headers, the
specified version of WebSockets and the specified sub protocols
|
ReadStream<WebSocket> |
HttpClient.websocketStream(String host,
String requestURI,
MultiMap headers)
Create a WebSocket stream to the specified host, relative request URI and default port and with the specified headers
|
ReadStream<WebSocket> |
HttpClient.websocketStream(String host,
String requestURI,
MultiMap headers,
WebsocketVersion version)
Create a WebSocket stream with the specified options and with the specified headers and using
the specified version of WebSockets
|
ReadStream<WebSocket> |
HttpClient.websocketStream(String host,
String requestURI,
MultiMap headers,
WebsocketVersion version,
String subProtocols)
Create a WebSocket stream to the specified host, relative request URI and default port, with the specified headers, using
the specified version of WebSockets, and the specified websocket sub protocols
|
Copyright © 2017. All rights reserved.