Package | Description |
---|---|
io.vertx.core.buffer |
== Buffers
:toc: left
Most data is shuffled around inside Vert.x using buffers.
|
io.vertx.core.datagram |
== Datagram sockets (UDP)
Using User Datagram Protocol (UDP) with Vert.x is a piece of cake.
|
io.vertx.core.dns |
== DNS client
Often you will find yourself in situations where you need to obtain DNS informations in an asynchronous fashion.
|
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.json | |
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.parsetools |
== Record Parser
The record parser allows you to easily parse protocols which are delimited by a sequence of bytes, or fixed
size records.
|
io.vertx.core.spi |
Modifier and Type | Method and Description |
---|---|
Buffer |
Buffer.appendBuffer(Buffer buff)
Appends the specified
Buffer to the end of this Buffer. |
Buffer |
Buffer.appendBuffer(Buffer buff,
int offset,
int len)
Appends the specified
Buffer starting at the offset using len to the end of this Buffer. |
Buffer |
Buffer.appendByte(byte b)
Appends the specified
byte to the end of the Buffer. |
Buffer |
Buffer.appendBytes(byte[] bytes)
Appends the specified
byte[] to the end of the Buffer. |
Buffer |
Buffer.appendBytes(byte[] bytes,
int offset,
int len)
Appends the specified number of bytes from
byte[] to the end of the Buffer, starting at the given offset. |
Buffer |
Buffer.appendDouble(double d)
Appends the specified
double to the end of the Buffer. |
Buffer |
Buffer.appendFloat(float f)
Appends the specified
float to the end of the Buffer. |
Buffer |
Buffer.appendInt(int i)
Appends the specified
int to the end of the Buffer. |
Buffer |
Buffer.appendIntLE(int i)
Appends the specified
int to the end of the Buffer in the Little Endian Byte Order. |
Buffer |
Buffer.appendLong(long l)
Appends the specified
long to the end of the Buffer. |
Buffer |
Buffer.appendLongLE(long l)
Appends the specified
long to the end of the Buffer in the Little Endian Byte Order. |
Buffer |
Buffer.appendMedium(int i)
Appends the specified 24bit
int to the end of the Buffer. |
Buffer |
Buffer.appendMediumLE(int i)
Appends the specified 24bit
int to the end of the Buffer in the Little Endian Byte Order. |
Buffer |
Buffer.appendShort(short s)
Appends the specified
short to the end of the Buffer.The buffer will expand as necessary to accommodate any bytes written. |
Buffer |
Buffer.appendShortLE(short s)
Appends the specified
short to the end of the Buffer in the Little Endian Byte Order.The buffer will expand as necessary to accommodate any bytes written. |
Buffer |
Buffer.appendString(String str)
Appends the specified
String str to the end of the Buffer with UTF-8 encoding. |
Buffer |
Buffer.appendString(String str,
String enc)
Appends the specified
String to the end of the Buffer with the encoding as specified by enc . |
Buffer |
Buffer.appendUnsignedByte(short b)
Appends the specified unsigned
byte to the end of the Buffer. |
Buffer |
Buffer.appendUnsignedInt(long i)
Appends the specified unsigned
int to the end of the Buffer. |
Buffer |
Buffer.appendUnsignedIntLE(long i)
Appends the specified unsigned
int to the end of the Buffer in the Little Endian Byte Order. |
Buffer |
Buffer.appendUnsignedShort(int s)
Appends the specified unsigned
short to the end of the Buffer.The buffer will expand as necessary to accommodate any bytes written. |
Buffer |
Buffer.appendUnsignedShortLE(int s)
Appends the specified unsigned
short to the end of the Buffer in the Little Endian Byte Order.The buffer will expand as necessary to accommodate any bytes written. |
static Buffer |
Buffer.buffer()
Create a new, empty buffer.
|
static Buffer |
Buffer.buffer(byte[] bytes)
Create a new buffer from a byte[].
|
static Buffer |
Buffer.buffer(io.netty.buffer.ByteBuf byteBuf)
Create a new buffer from a Netty
ByteBuf . |
static Buffer |
Buffer.buffer(int initialSizeHint)
Create a new buffer given the initial size hint.
|
static Buffer |
Buffer.buffer(String string)
Create a new buffer from a string.
|
static Buffer |
Buffer.buffer(String string,
String enc)
Create a new buffer from a string and using the specified encoding.
|
Buffer |
Buffer.copy()
Returns a copy of the entire Buffer.
|
Buffer |
Buffer.getBuffer(int start,
int end)
Returns a copy of a sub-sequence the Buffer as a
Buffer starting at position start
and ending at position end - 1 |
Buffer |
Buffer.getBytes(byte[] dst)
Transfers the content of the Buffer into a
byte[] . |
Buffer |
Buffer.getBytes(byte[] dst,
int dstIndex)
Transfers the content of the Buffer into a
byte[] at the specific destination. |
Buffer |
Buffer.getBytes(int start,
int end,
byte[] dst)
Transfers the content of the Buffer starting at position
start and ending at position end - 1
into a byte[] . |
Buffer |
Buffer.getBytes(int start,
int end,
byte[] dst,
int dstIndex)
Transfers the content of the Buffer starting at position
start and ending at position end - 1
into a byte[] at the specific destination. |
Buffer |
Buffer.setBuffer(int pos,
Buffer b)
Sets the bytes at position
pos in the Buffer to the bytes represented by the Buffer b . |
Buffer |
Buffer.setBuffer(int pos,
Buffer b,
int offset,
int len)
Sets the bytes at position
pos in the Buffer to the bytes represented by the Buffer b on the given offset and len . |
Buffer |
Buffer.setByte(int pos,
byte b)
Sets the
byte at position pos in the Buffer to the value b . |
Buffer |
Buffer.setBytes(int pos,
byte[] b)
Sets the bytes at position
pos in the Buffer to the bytes represented by the byte[] b . |
Buffer |
Buffer.setBytes(int pos,
byte[] b,
int offset,
int len)
Sets the given number of bytes at position
pos in the Buffer to the bytes represented by the byte[] b . |
Buffer |
Buffer.setBytes(int pos,
ByteBuffer b)
Sets the bytes at position
pos in the Buffer to the bytes represented by the ByteBuffer b . |
Buffer |
Buffer.setDouble(int pos,
double d)
Sets the
double at position pos in the Buffer to the value d . |
Buffer |
Buffer.setFloat(int pos,
float f)
Sets the
float at position pos in the Buffer to the value f . |
Buffer |
Buffer.setInt(int pos,
int i)
Sets the
int at position pos in the Buffer to the value i . |
Buffer |
Buffer.setIntLE(int pos,
int i)
Sets the
int at position pos in the Buffer to the value i in the Little Endian Byte Order. |
Buffer |
Buffer.setLong(int pos,
long l)
Sets the
long at position pos in the Buffer to the value l . |
Buffer |
Buffer.setLongLE(int pos,
long l)
Sets the
long at position pos in the Buffer to the value l in the Little Endian Byte Order. |
Buffer |
Buffer.setMedium(int pos,
int i)
Sets the 24bit
int at position pos in the Buffer to the value i . |
Buffer |
Buffer.setMediumLE(int pos,
int i)
Sets the 24bit
int at position pos in the Buffer to the value i . |
Buffer |
Buffer.setShort(int pos,
short s)
Sets the
short at position pos in the Buffer to the value s . |
Buffer |
Buffer.setShortLE(int pos,
short s)
Sets the
short at position pos in the Buffer to the value s in the Little Endian Byte Order. |
Buffer |
Buffer.setString(int pos,
String str)
Sets the bytes at position
pos in the Buffer to the value of str encoded in UTF-8. |
Buffer |
Buffer.setString(int pos,
String str,
String enc)
Sets the bytes at position
pos in the Buffer to the value of str encoded in encoding enc . |
Buffer |
Buffer.setUnsignedByte(int pos,
short b)
Sets the unsigned
byte at position pos in the Buffer to the value b . |
Buffer |
Buffer.setUnsignedInt(int pos,
long i)
Sets the unsigned
int at position pos in the Buffer to the value i . |
Buffer |
Buffer.setUnsignedIntLE(int pos,
long i)
Sets the unsigned
int at position pos in the Buffer to the value i in the Little Endian Byte Order. |
Buffer |
Buffer.setUnsignedShort(int pos,
int s)
Sets the unsigned
short at position pos in the Buffer to the value s . |
Buffer |
Buffer.setUnsignedShortLE(int pos,
int s)
Sets the unsigned
short at position pos in the Buffer to the value s in the Little Endian Byte Order. |
Buffer |
Buffer.slice()
Returns a slice of this buffer.
|
Buffer |
Buffer.slice(int start,
int end)
Returns a slice of this buffer.
|
Modifier and Type | Method and Description |
---|---|
Buffer |
Buffer.appendBuffer(Buffer buff)
Appends the specified
Buffer to the end of this Buffer. |
Buffer |
Buffer.appendBuffer(Buffer buff,
int offset,
int len)
Appends the specified
Buffer starting at the offset using len to the end of this Buffer. |
Buffer |
Buffer.setBuffer(int pos,
Buffer b)
Sets the bytes at position
pos in the Buffer to the bytes represented by the Buffer b . |
Buffer |
Buffer.setBuffer(int pos,
Buffer b,
int offset,
int len)
Sets the bytes at position
pos in the Buffer to the bytes represented by the Buffer b on the given offset and len . |
Modifier and Type | Method and Description |
---|---|
Buffer |
DatagramPacket.data()
Returns the data of the
DatagramPacket |
Modifier and Type | Method and Description |
---|---|
DatagramSocket |
DatagramSocket.send(Buffer packet,
int port,
String host,
Handler<AsyncResult<DatagramSocket>> handler)
Write the given
Buffer to the SocketAddress . |
PacketWritestream |
PacketWritestream.write(Buffer data) |
Modifier and Type | Method and Description |
---|---|
Buffer |
AddressResolverOptions.getHostsValue() |
Modifier and Type | Method and Description |
---|---|
AddressResolverOptions |
AddressResolverOptions.setHostsValue(Buffer hostsValue)
Set an alternate hosts configuration file to use instead of the one provided by the os.
|
Modifier and Type | Method and Description |
---|---|
EventBusOptions |
EventBusOptions.addCrlValue(Buffer crlValue) |
R |
MessageCodec.decodeFromWire(int pos,
Buffer buffer)
Called by Vert.x when a message is decoded from the wire.
|
void |
MessageCodec.encodeToWire(Buffer buffer,
S s)
Called by Vert.x when marshalling a message to the wire.
|
Modifier and Type | Method and Description |
---|---|
Buffer |
FileSystem.readFileBlocking(String path)
Blocking version of
FileSystem.readFile(String, Handler) |
Modifier and Type | Method and Description |
---|---|
AsyncFile |
AsyncFile.read(Buffer buffer,
int offset,
long position,
int length,
Handler<AsyncResult<Buffer>> handler)
Reads
length bytes of data from the file at position position in the file, asynchronously. |
AsyncFile |
AsyncFile.write(Buffer data) |
AsyncFile |
AsyncFile.write(Buffer buffer,
long position,
Handler<AsyncResult<Void>> handler)
Write a
Buffer to the file at position position in the file, asynchronously. |
FileSystem |
FileSystem.writeFile(String path,
Buffer data,
Handler<AsyncResult<Void>> handler)
Creates the file, and writes the specified
Buffer data to the file represented by the path path ,
asynchronously. |
FileSystem |
FileSystem.writeFileBlocking(String path,
Buffer data)
Blocking version of
FileSystem.writeFile(String, Buffer, Handler) |
Modifier and Type | Method and Description |
---|---|
AsyncFile |
AsyncFile.handler(Handler<Buffer> handler) |
AsyncFile |
AsyncFile.read(Buffer buffer,
int offset,
long position,
int length,
Handler<AsyncResult<Buffer>> handler)
Reads
length bytes of data from the file at position position in the file, asynchronously. |
FileSystem |
FileSystem.readFile(String path,
Handler<AsyncResult<Buffer>> handler)
Reads the entire file as represented by the path
path as a Buffer , asynchronously. |
Modifier and Type | Method and Description |
---|---|
Buffer |
WebSocketFrame.binaryData() |
Buffer |
GoAway.getDebugData() |
Buffer |
HttpFrame.payload() |
Modifier and Type | Method and Description |
---|---|
HttpServerOptions |
HttpServerOptions.addCrlValue(Buffer crlValue) |
HttpClientOptions |
HttpClientOptions.addCrlValue(Buffer crlValue) |
static WebSocketFrame |
WebSocketFrame.binaryFrame(Buffer data,
boolean isFinal)
Create a binary WebSocket frame.
|
static WebSocketFrame |
WebSocketFrame.continuationFrame(Buffer data,
boolean isFinal)
Create a continuation frame
|
void |
HttpServerResponse.end(Buffer chunk)
Same as
HttpServerResponse.end() but writes some data to the response body before ending. |
void |
HttpClientRequest.end(Buffer chunk)
Same as
HttpClientRequest.end() but writes some data to the request body before ending. |
HttpConnection |
HttpConnection.goAway(long errorCode,
int lastStreamId,
Buffer debugData)
Send a go away frame to the remote endpoint of the connection.
|
HttpConnection |
HttpConnection.ping(Buffer data,
Handler<AsyncResult<Buffer>> pongHandler)
Send a PING frame to the remote endpoint.
|
GoAway |
GoAway.setDebugData(Buffer debugData)
Set the additional debug data
|
WebSocketBase |
WebSocketBase.write(Buffer data) |
WebSocket |
WebSocket.write(Buffer data) |
ServerWebSocket |
ServerWebSocket.write(Buffer data) |
HttpServerResponse |
HttpServerResponse.write(Buffer data) |
HttpClientRequest |
HttpClientRequest.write(Buffer data) |
WebSocketBase |
WebSocketBase.writeBinaryMessage(Buffer data)
Writes a (potentially large) piece of binary data to the connection.
|
WebSocket |
WebSocket.writeBinaryMessage(Buffer data) |
ServerWebSocket |
ServerWebSocket.writeBinaryMessage(Buffer data) |
HttpServerResponse |
HttpServerResponse.writeCustomFrame(int type,
int flags,
Buffer payload)
Write an HTTP/2 frame to the response, allowing to extend the HTTP/2 protocol.
|
HttpClientRequest |
HttpClientRequest.writeCustomFrame(int type,
int flags,
Buffer payload)
Write an HTTP/2 frame to the request, allowing to extend the HTTP/2 protocol.
|
WebSocketBase |
WebSocketBase.writeFinalBinaryFrame(Buffer data)
Write a final WebSocket binary frame to the connection
|
WebSocket |
WebSocket.writeFinalBinaryFrame(Buffer data) |
ServerWebSocket |
ServerWebSocket.writeFinalBinaryFrame(Buffer data) |
Modifier and Type | Method and Description |
---|---|
HttpClientResponse |
HttpClientResponse.bodyHandler(Handler<Buffer> bodyHandler)
Convenience method for receiving the entire request body in one piece.
|
WebSocketBase |
WebSocketBase.handler(Handler<Buffer> handler) |
WebSocket |
WebSocket.handler(Handler<Buffer> handler) |
ServerWebSocket |
ServerWebSocket.handler(Handler<Buffer> handler) |
HttpServerRequest |
HttpServerRequest.handler(Handler<Buffer> handler) |
HttpServerFileUpload |
HttpServerFileUpload.handler(Handler<Buffer> handler) |
HttpClientResponse |
HttpClientResponse.handler(Handler<Buffer> handler) |
HttpConnection |
HttpConnection.ping(Buffer data,
Handler<AsyncResult<Buffer>> pongHandler)
Send a PING frame to the remote endpoint.
|
Modifier and Type | Method and Description |
---|---|
int |
JsonObject.readFromBuffer(int pos,
Buffer buffer) |
int |
JsonArray.readFromBuffer(int pos,
Buffer buffer) |
void |
JsonObject.writeToBuffer(Buffer buffer) |
void |
JsonArray.writeToBuffer(Buffer buffer) |
Modifier and Type | Method and Description |
---|---|
Buffer |
PemKeyCertOptions.getCertValue()
Get the certificate as a buffer
|
Buffer |
PemKeyCertOptions.getKeyValue()
Get the key as a buffer
|
Buffer |
PfxOptions.getValue()
Get the store as a buffer
|
Buffer |
JksOptions.getValue()
Get the key store as a buffer
|
Modifier and Type | Method and Description |
---|---|
List<Buffer> |
PemTrustOptions.getCertValues() |
List<Buffer> |
TCPSSLOptions.getCrlValues()
Get the CRL values
|
Modifier and Type | Method and Description |
---|---|
PemTrustOptions |
PemTrustOptions.addCertValue(Buffer certValue)
Add a certificate value
|
TCPSSLOptions |
TCPSSLOptions.addCrlValue(Buffer crlValue)
Add a CRL value
|
NetServerOptions |
NetServerOptions.addCrlValue(Buffer crlValue) |
NetClientOptions |
NetClientOptions.addCrlValue(Buffer crlValue) |
PemKeyCertOptions |
PemKeyCertOptions.setCertValue(Buffer certValue)
Set the certificate as a buffer
|
PemKeyCertOptions |
PemKeyCertOptions.setKeyValue(Buffer keyValue)
Set the key a a buffer
|
PfxOptions |
PfxOptions.setValue(Buffer value)
Set the store as a buffer
|
JksOptions |
JksOptions.setValue(Buffer value)
Set the key store as a buffer
|
NetSocket |
NetSocket.write(Buffer data) |
Modifier and Type | Method and Description |
---|---|
NetSocket |
NetSocket.handler(Handler<Buffer> handler) |
Modifier and Type | Method and Description |
---|---|
void |
RecordParser.delimitedMode(Buffer delim)
Flip the parser into delimited mode, and where the delimiter can be represented
by the delimiter
delim . |
void |
RecordParser.handle(Buffer buffer)
This method is called to provide the parser with data.
|
static RecordParser |
RecordParser.newDelimited(Buffer delim,
Handler<Buffer> output)
Create a new
RecordParser instance, initially in delimited mode, and where the delimiter can be represented
by the Buffer delim. |
Modifier and Type | Method and Description |
---|---|
static RecordParser |
RecordParser.newDelimited(Buffer delim,
Handler<Buffer> output)
Create a new
RecordParser instance, initially in delimited mode, and where the delimiter can be represented
by the Buffer delim. |
static RecordParser |
RecordParser.newDelimited(String delim,
Handler<Buffer> output)
Create a new
RecordParser instance, initially in delimited mode, and where the delimiter can be represented
by the String delim endcoded in latin-1 . |
static RecordParser |
RecordParser.newFixed(int size,
Handler<Buffer> output)
Create a new
RecordParser instance, initially in fixed size mode, and where the record size is specified
by the size parameter. |
void |
RecordParser.setOutput(Handler<Buffer> output) |
Modifier and Type | Method and Description |
---|---|
Buffer |
BufferFactory.buffer() |
Buffer |
BufferFactory.buffer(byte[] bytes) |
Buffer |
BufferFactory.buffer(io.netty.buffer.ByteBuf byteBuffer) |
Buffer |
BufferFactory.buffer(int initialSizeHint) |
Buffer |
BufferFactory.buffer(String str) |
Buffer |
BufferFactory.buffer(String str,
String enc) |
Modifier and Type | Method and Description |
---|---|
WebSocketFrame |
WebSocketFrameFactory.binaryFrame(Buffer data,
boolean isFinal) |
WebSocketFrame |
WebSocketFrameFactory.continuationFrame(Buffer data,
boolean isFinal) |
Copyright © 2016. All rights reserved.