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.datagram |
== Datagram sockets (UDP)
Using User Datagram Protocol (UDP) with Vert.x is a piece of cake.
|
io.vertx.core.eventbus |
== The Event Bus
:toc: left
The
event bus is the *nervous system* of Vert.x. |
io.vertx.core.file |
== Using the file system with Vert.x
The Vert.x
FileSystem object provides many operations for manipulating the file system. |
io.vertx.core.http |
== Writing HTTP servers and clients
Vert.x allows you to easily write non blocking HTTP clients and servers.
|
io.vertx.core.net |
== Writing TCP servers and clients
Vert.x allows you to easily write non blocking TCP clients and servers.
|
io.vertx.core.spi | |
io.vertx.core.streams |
== Streams
There are several objects in Vert.x that allow items to be read from and written.
|
io.vertx.rx.java |
Modifier and Type | Interface and Description |
---|---|
interface |
TimeoutStream
A timeout stream is triggered by a timer, the
Handler will be call when the timer is fired,
it can be once or several times depending on the nature of the timer related to this stream. |
Modifier and Type | Interface and Description |
---|---|
interface |
DatagramSocket
A datagram socket can be used to send
DatagramPacket 's to remote datagram servers
and receive DatagramPacket s . |
Modifier and Type | Interface and Description |
---|---|
interface |
MessageConsumer<T>
An event bus consumer object representing a stream of message to an
EventBus address that can
be read from. |
Modifier and Type | Method and Description |
---|---|
ReadStream<T> |
MessageConsumer.bodyStream() |
Modifier and Type | Interface and Description |
---|---|
interface |
AsyncFile
Represents a file on the file-system which can be read from, or written to asynchronously.
|
Modifier and Type | Interface and Description |
---|---|
interface |
HttpClientRequest
Represents a client-side HTTP request.
|
interface |
HttpClientResponse
Represents a client-side HTTP response.
|
interface |
HttpServerFileUpload
Represents an file upload from an HTML FORM.
|
interface |
HttpServerRequest
Represents a server-side HTTP request.
|
interface |
ServerWebSocket
Represents a server side WebSocket.
|
interface |
WebSocket
Represents a client-side WebSocket.
|
interface |
WebSocketBase
Base WebSocket implementation.
|
Modifier and Type | Method and Description |
---|---|
ReadStream<HttpServerRequest> |
HttpServer.requestStream()
Return the request stream for the server.
|
ReadStream<ServerWebSocket> |
HttpServer.websocketStream()
Return the websocket stream for the server.
|
ReadStream<WebSocket> |
HttpClient.websocketStream(int port,
String host,
String requestURI)
Create a WebSocket stream to the specified port, host and relative request URI
|
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)
Create a WebSocket stream with the specified options
|
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)
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)
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)
Create a WebSocket stream to the specified host, relative request URI and default port
|
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
|
Modifier and Type | Interface and Description |
---|---|
interface |
NetSocket
Represents a socket-like interface to a TCP connection on either the
client or the server side.
|
Modifier and Type | Method and Description |
---|---|
ReadStream<NetSocket> |
NetServer.connectStream()
Return the connect stream for this server.
|
Modifier and Type | Method and Description |
---|---|
<T> Pump |
PumpFactory.pump(ReadStream<T> rs,
WriteStream<T> ws) |
<T> Pump |
PumpFactory.pump(ReadStream<T> rs,
WriteStream<T> ws,
int writeQueueMaxSize) |
Modifier and Type | Method and Description |
---|---|
ReadStream<T> |
ReadStream.endHandler(Handler<Void> endHandler)
Set an end handler.
|
ReadStream<T> |
ReadStream.exceptionHandler(Handler<Throwable> handler)
Set an exception handler on the read stream.
|
ReadStream<T> |
ReadStream.handler(Handler<T> handler)
Set a data handler.
|
ReadStream<T> |
ReadStream.pause()
Pause the
ReadSupport . |
ReadStream<T> |
ReadStream.resume()
Resume reading.
|
Modifier and Type | Method and Description |
---|---|
static <T> Pump |
Pump.pump(ReadStream<T> rs,
WriteStream<T> ws)
Create a new
Pump with the given ReadStream and WriteStream |
static <T> Pump |
Pump.pump(ReadStream<T> rs,
WriteStream<T> ws,
int writeQueueMaxSize)
Create a new
Pump with the given ReadStream and WriteStream and
writeQueueMaxSize |
Modifier and Type | Class and Description |
---|---|
class |
ReadStreamSubscriber<R,J>
|
Modifier and Type | Method and Description |
---|---|
static <R,J> ReadStream<J> |
ReadStreamSubscriber.asReadStream(rx.Observable<R> observable,
Function<R,J> adapter) |
ReadStream<J> |
ReadStreamSubscriber.endHandler(Handler<Void> handler) |
ReadStream<J> |
ReadStreamSubscriber.exceptionHandler(Handler<Throwable> handler) |
ReadStream<J> |
ReadStreamSubscriber.handler(Handler<J> handler) |
ReadStream<J> |
ReadStreamSubscriber.pause() |
ReadStream<J> |
ReadStreamSubscriber.resume() |
static <T> ReadStream<T> |
RxHelper.toReadStream(rx.Observable<T> observable)
Adapts an RxJava
Observable to a Vert.x io.vertx.core.streams.ReadStream . |
Modifier and Type | Method and Description |
---|---|
static <T> rx.Observable<T> |
RxHelper.toObservable(ReadStream<T> stream)
Adapts a Vert.x
io.vertx.core.streams.ReadStream to an RxJava Observable . |
static <T,R> rx.Observable<R> |
RxHelper.toObservable(ReadStream<T> stream,
Function<T,R> adapter)
Like
RxHelper.toObservable(ReadStream) but with a function that adapts the items. |
static <T,R> rx.Observable<R> |
RxHelper.toObservable(ReadStream<T> stream,
Function<T,R> adapter,
int maxBufferSize)
Like
RxHelper.toObservable(ReadStream, int) but with a function that adapts the items. |
static <T> rx.Observable<T> |
RxHelper.toObservable(ReadStream<T> stream,
int maxBufferSize)
Adapts a Vert.x
io.vertx.core.streams.ReadStream to an RxJava Observable . |
Constructor and Description |
---|
ObservableReadStream(ReadStream<T> stream,
Function<T,R> adapter) |
ObservableReadStream(ReadStream<T> stream,
Function<T,R> adapter,
long maxBufferSize) |
Copyright © 2018. All rights reserved.