Vert.x 4.5.13 · io.vertx.core.datagram.impl.PacketWriteStreamImpl

Modifier and Type	Field and Description
private DatagramSocketImpl	datagramSocket
private Handler<Throwable>	exceptionHandler
private final String	host
private final int	port

Access	Constructor and Description
pack-priv	PacketWriteStreamImpl(DatagramSocketImpl datagramSocket, int port, String host)

Method Summary

Modifier and Type	Method and Description
public PacketWriteStreamImpl	drainHandler(Handler<Void> handler)
public Future<Void>	end() Overrides default io.vertx.core.streams.WriteStream.end. Ends the stream.
public void	end(Handler<AsyncResult<Void>> handler) Overrides default io.vertx.core.streams.WriteStream.end. Implements io.vertx.core.streams.WriteStream.end. Same as `end()` but with an `handler` called when the operation completes
public PacketWriteStreamImpl	exceptionHandler(Handler<Throwable> handler)
public void	handle(AsyncResult<Void> the event to handle event) Implements io.vertx.core.Handler.handle. Something has happened, so handle it.
public PacketWriteStreamImpl	setWriteQueueMaxSize(int the max size of the write stream maxSize) Implements io.vertx.core.streams.WriteStream.setWriteQueueMaxSize. Set the maximum size of the write queue to `maxSize`.
public Future<Void>	write(Buffer the data to write data) Implements io.vertx.core.streams.WriteStream.write. References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. Write some data to the stream.
public void	write(Buffer data, Handler<AsyncResult<Void>> handler) Implements io.vertx.core.streams.WriteStream.write. References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. Same as `write(T)` but with an `handler` called when the operation completes
public boolean	writeQueueFull() Implements io.vertx.core.streams.WriteStream.writeQueueFull. This will return `true` if there are more bytes in the write queue than the value set using `setWriteQueueMaxSize`

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

datagramSocket	back to summary
private DatagramSocketImpl datagramSocket

exceptionHandler	back to summary
private Handler<Throwable> exceptionHandler

host	back to summary
private final String host

port	back to summary
private final int port

PacketWriteStreamImpl	back to summary
pack-priv PacketWriteStreamImpl(DatagramSocketImpl datagramSocket, int port, String host)

Method Detail

drainHandler	back to summary
public PacketWriteStreamImpl drainHandler(Handler<Void> handler) Annotations @Override

end	back to summary
public Future<Void> end() Overrides default io.vertx.core.streams.WriteStream.end. Doc from io.vertx.core.streams.WriteStream.end. Ends the stream. Once the stream has ended, it cannot be used any more. Returns:Future<Void> a future completed with the result Annotations @Override

end

back to summary

public Future<Void> end()

Overrides default io.vertx.core.streams.WriteStream.end.

Doc from io.vertx.core.streams.WriteStream.end.

Ends the stream.

Once the stream has ended, it cannot be used any more.

Returns:Future<Void>

a future completed with the result

Annotations

@Override

end back to summary

end	back to summary
public void end(Handler<AsyncResult<Void>> handler) Overrides default io.vertx.core.streams.WriteStream.end. Implements io.vertx.core.streams.WriteStream.end. Doc from io.vertx.core.streams.WriteStream.end. Same as `end()` but with an `handler` called when the operation completes Annotations @Override

public void end(Handler<AsyncResult<Void>> handler)

Overrides default io.vertx.core.streams.WriteStream.end.

Implements io.vertx.core.streams.WriteStream.end.

Doc from io.vertx.core.streams.WriteStream.end.

Same as end() but with an handler called when the operation completes

Annotations

@Override

exceptionHandler	back to summary
public PacketWriteStreamImpl exceptionHandler(Handler<Throwable> handler) Annotations @Override

handle	back to summary
public void handle(AsyncResult<Void> event) Implements io.vertx.core.Handler.handle. Doc from io.vertx.core.Handler.handle. Something has happened, so handle it. Parameters event:AsyncResult<Void> the event to handle Annotations @Override

handle

back to summary

public void handle(AsyncResult<Void> event)

Implements io.vertx.core.Handler.handle.

Doc from io.vertx.core.Handler.handle.

Something has happened, so handle it.

Parameters

event:AsyncResult<Void>: the event to handle

Annotations

@Override

setWriteQueueMaxSize back to summary

setWriteQueueMaxSize	back to summary
public PacketWriteStreamImpl setWriteQueueMaxSize(int maxSize) Implements io.vertx.core.streams.WriteStream.setWriteQueueMaxSize. Doc from io.vertx.core.streams.WriteStream.setWriteQueueMaxSize. Set the maximum size of the write queue to `maxSize`. You will still be able to write to the stream even if there is more than `maxSize` items in the write queue. This is used as an indicator by classes such as `Pipe` to provide flow control. The value is defined by the implementation of the stream, e.g in bytes for a `io.vertx.core.net.NetSocket`, etc... Parameters maxSize:int the max size of the write stream Returns:PacketWriteStreamImpl a reference to this, so the API can be used fluently Annotations @Override

public PacketWriteStreamImpl setWriteQueueMaxSize(int maxSize)

Implements io.vertx.core.streams.WriteStream.setWriteQueueMaxSize.

Doc from io.vertx.core.streams.WriteStream.setWriteQueueMaxSize.

Set the maximum size of the write queue to maxSize. You will still be able to write to the stream even if there is more than maxSize items in the write queue. This is used as an indicator by classes such as Pipe to provide flow control.

The value is defined by the implementation of the stream, e.g in bytes for a io.vertx.core.net.NetSocket, etc...

Parameters

maxSize:int: the max size of the write stream

Returns:PacketWriteStreamImpl

a reference to this, so the API can be used fluently

Annotations

@Override

write back to summary

write	back to summary
public Future<Void> write(Buffer data) Implements io.vertx.core.streams.WriteStream.write. Doc from io.vertx.core.streams.WriteStream.write. References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Write some data to the stream. The data is usually put on an internal write queue, and the write actually happens asynchronously. To avoid running out of memory by putting too much on the write queue, check the `writeQueueFull` method before writing. This is done automatically if using a `Pipe`. When the `data` is moved from the queue to the actual medium, the returned `Future` will be completed with the write result, e.g the future is succeeded when a server HTTP response buffer is written to the socket and failed if the remote client has closed the socket while the data was still pending for write. Parameters data:Buffer the data to write Returns:Future<Void> a future completed with the write result Annotations @Override

public Future<Void> write(Buffer data)

Implements io.vertx.core.streams.WriteStream.write.

Doc from io.vertx.core.streams.WriteStream.write.

References Deprecated

Buffer is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Write some data to the stream.

The data is usually put on an internal write queue, and the write actually happens asynchronously. To avoid running out of memory by putting too much on the write queue, check the writeQueueFull method before writing. This is done automatically if using a Pipe.

When the data is moved from the queue to the actual medium, the returned Future will be completed with the write result, e.g the future is succeeded when a server HTTP response buffer is written to the socket and failed if the remote client has closed the socket while the data was still pending for write.

Parameters

data:Buffer: the data to write

Returns:Future<Void>

a future completed with the write result

Annotations

@Override

write back to summary

write	back to summary
public void write(Buffer data, Handler<AsyncResult<Void>> handler) Implements io.vertx.core.streams.WriteStream.write. Doc from io.vertx.core.streams.WriteStream.write. References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Same as `write(T)` but with an `handler` called when the operation completes Annotations @Override

public void write(Buffer data, Handler<AsyncResult<Void>> handler)

Implements io.vertx.core.streams.WriteStream.write.

Doc from io.vertx.core.streams.WriteStream.write.

References Deprecated

Buffer is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Same as write(T) but with an handler called when the operation completes

Annotations

@Override

writeQueueFull back to summary

writeQueueFull	back to summary
public boolean writeQueueFull() Implements io.vertx.core.streams.WriteStream.writeQueueFull. Doc from io.vertx.core.streams.WriteStream.writeQueueFull. This will return `true` if there are more bytes in the write queue than the value set using `setWriteQueueMaxSize` Returns:boolean `true` if write queue is full Annotations @Override

public boolean writeQueueFull()

Implements io.vertx.core.streams.WriteStream.writeQueueFull.

Doc from io.vertx.core.streams.WriteStream.writeQueueFull.

This will return true if there are more bytes in the write queue than the value set using setWriteQueueMaxSize

Returns:boolean

true if write queue is full

Annotations

@Override

pack-priv Class PacketWriteStreamImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail