XNIO API 3.8.13.Final · org.xnio.channels.WritableMessageChannel

Method Summary

Modifier and Type	Method and Description
public ChannelListener.Setter<? extends WritableMessageChannel>	getCloseSetter() Redeclares org.xnio.channels.SuspendableWriteChannel.getCloseSetter. Get the setter which can be used to change the close listener for this channel.
public ChannelListener.Setter<? extends WritableMessageChannel>	getWriteSetter() Redeclares org.xnio.channels.SuspendableWriteChannel.getWriteSetter. Get the setter which can be used to change the write listener for this channel.
public boolean	Returns: the result of the send operation; `true` if the message was sent, or `false` if it would block send(ByteBuffer the message to send buffer) Send a complete message.
public boolean	Returns: the result of the send operation; `true` if the message was sent, or `false` if it would block send(ByteBuffer[] the buffers holding the message to send buffers) Send a complete message.
public boolean	Returns: the result of the send operation; `true` if the message was sent, or `false` if it would block send(ByteBuffer[] the buffers holding the message to send buffers, int the offset into the buffer array of the first buffer offs, int the number of buffers that contain data to send len) Send a complete message.
public boolean	Returns: the result of the send operation; `true` if the message was sent, or `false` if it would block sendFinal(ByteBuffer the message to send buffer) Send a complete message.
public boolean	Returns: the result of the send operation; `true` if the message was sent, or `false` if it would block sendFinal(ByteBuffer[] the buffers holding the message to send buffers) Send a complete message.
public boolean	Returns: the result of the send operation; `true` if the message was sent, or `false` if it would block sendFinal(ByteBuffer[] the buffers holding the message to send buffers, int the offset into the buffer array of the first buffer offs, int the number of buffers that contain data to send len) Send a complete message.

Inherited from org.xnio.channels.Configurable:: getOption setOption supportsOption
Inherited from org.xnio.channels.SuspendableWriteChannel:: awaitWritable awaitWritable close flush getWriteThread isOpen isWriteResumed resumeWrites shutdownWrites suspendWrites wakeupWrites

Method Detail

getCloseSetter	back to summary
public ChannelListener.Setter<? extends WritableMessageChannel> getCloseSetter() Redeclares org.xnio.channels.SuspendableWriteChannel.getCloseSetter. Doc from org.xnio.channels.SuspendableWriteChannel.getCloseSetter. Get the setter which can be used to change the close listener for this channel. If the channel is already closed, then the listener will not be called. Returns:ChannelListener.Setter<? extends WritableMessageChannel> Doc from org.xnio.channels.CloseableChannel.getCloseSetter. the setter

getCloseSetter

back to summary

public ChannelListener.Setter<? extends WritableMessageChannel> getCloseSetter()

Redeclares org.xnio.channels.SuspendableWriteChannel.getCloseSetter.

Doc from org.xnio.channels.SuspendableWriteChannel.getCloseSetter.

Get the setter which can be used to change the close listener for this channel. If the channel is already closed, then the listener will not be called.

Returns:ChannelListener.Setter<? extends WritableMessageChannel>

Doc from org.xnio.channels.CloseableChannel.getCloseSetter.

the setter

getWriteSetter	back to summary
public ChannelListener.Setter<? extends WritableMessageChannel> getWriteSetter() Redeclares org.xnio.channels.SuspendableWriteChannel.getWriteSetter. Doc from org.xnio.channels.SuspendableWriteChannel.getWriteSetter. Get the setter which can be used to change the write listener for this channel. Returns:ChannelListener.Setter<? extends WritableMessageChannel> the setter

getWriteSetter

back to summary

public ChannelListener.Setter<? extends WritableMessageChannel> getWriteSetter()

Redeclares org.xnio.channels.SuspendableWriteChannel.getWriteSetter.

Doc from org.xnio.channels.SuspendableWriteChannel.getWriteSetter.

Get the setter which can be used to change the write listener for this channel.

Returns:ChannelListener.Setter<? extends WritableMessageChannel>: the setter

send back to summary

send	back to summary
public boolean send(ByteBuffer buffer) throws IOException Send a complete message. Parameters buffer:ByteBuffer the message to send Returns:boolean the result of the send operation; `true` if the message was sent, or `false` if it would block Exceptions IOException: if an I/O error occurs

public boolean send(ByteBuffer buffer) throws IOException

Send a complete message.

Parameters

buffer:ByteBuffer: the message to send

Returns:boolean

the result of the send operation; true if the message was sent, or false if it would block

Exceptions

IOException:: if an I/O error occurs

send back to summary

send	back to summary
public boolean send(ByteBuffer[] buffers) throws IOException Send a complete message. Parameters buffers:ByteBuffer[] the buffers holding the message to send Returns:boolean the result of the send operation; `true` if the message was sent, or `false` if it would block Exceptions IOException: if an I/O error occurs

public boolean send(ByteBuffer[] buffers) throws IOException

Send a complete message.

Parameters

buffers:ByteBuffer[]: the buffers holding the message to send

Returns:boolean

the result of the send operation; true if the message was sent, or false if it would block

Exceptions

IOException:: if an I/O error occurs

send back to summary

send	back to summary
public boolean send(ByteBuffer[] buffers, int offs, int len) throws IOException Send a complete message. Parameters buffers:ByteBuffer[] the buffers holding the message to send offs:int the offset into the buffer array of the first buffer len:int the number of buffers that contain data to send Returns:boolean the result of the send operation; `true` if the message was sent, or `false` if it would block Exceptions IOException: if an I/O error occurs

public boolean send(ByteBuffer[] buffers, int offs, int len) throws IOException

Send a complete message.

Parameters

buffers:ByteBuffer[]: the buffers holding the message to send
offs:int: the offset into the buffer array of the first buffer
len:int: the number of buffers that contain data to send

Returns:boolean

the result of the send operation; true if the message was sent, or false if it would block

Exceptions

IOException:: if an I/O error occurs

sendFinal back to summary

sendFinal	back to summary
public boolean sendFinal(ByteBuffer buffer) throws IOException Send a complete message. If the message was successfully sent the channel with have its writes shutdown. Parameters buffer:ByteBuffer the message to send Returns:boolean the result of the send operation; `true` if the message was sent, or `false` if it would block Exceptions IOException: if an I/O error occurs

public boolean sendFinal(ByteBuffer buffer) throws IOException

Send a complete message. If the message was successfully sent the channel with have its writes shutdown.

Parameters

buffer:ByteBuffer: the message to send

Returns:boolean

the result of the send operation; true if the message was sent, or false if it would block

Exceptions

IOException:: if an I/O error occurs

sendFinal back to summary

sendFinal	back to summary
public boolean sendFinal(ByteBuffer[] buffers) throws IOException Send a complete message. If the message was successfully sent the channel with have its writes shutdown. Parameters buffers:ByteBuffer[] the buffers holding the message to send Returns:boolean the result of the send operation; `true` if the message was sent, or `false` if it would block Exceptions IOException: if an I/O error occurs

public boolean sendFinal(ByteBuffer[] buffers) throws IOException

Send a complete message. If the message was successfully sent the channel with have its writes shutdown.

Parameters

buffers:ByteBuffer[]: the buffers holding the message to send

Returns:boolean

the result of the send operation; true if the message was sent, or false if it would block

Exceptions

IOException:: if an I/O error occurs

sendFinal back to summary

sendFinal	back to summary
public boolean sendFinal(ByteBuffer[] buffers, int offs, int len) throws IOException Send a complete message. If the message was successfully sent the channel with have its writes shutdown. Parameters buffers:ByteBuffer[] the buffers holding the message to send offs:int the offset into the buffer array of the first buffer len:int the number of buffers that contain data to send Returns:boolean the result of the send operation; `true` if the message was sent, or `false` if it would block Exceptions IOException: if an I/O error occurs

public boolean sendFinal(ByteBuffer[] buffers, int offs, int len) throws IOException

Send a complete message. If the message was successfully sent the channel with have its writes shutdown.

Parameters

buffers:ByteBuffer[]: the buffers holding the message to send
offs:int: the offset into the buffer array of the first buffer
len:int: the number of buffers that contain data to send

Returns:boolean

the result of the send operation; true if the message was sent, or false if it would block

Exceptions

IOException:: if an I/O error occurs

public Interface WritableMessageChannel

Field Summary

Method Summary

Method Detail