- All Superinterfaces:
AutoCloseable
,Channel
,Closeable
,CloseableChannel
,Configurable
,InterruptibleChannel
,SuspendableWriteChannel
- All Known Subinterfaces:
ConnectedMessageChannel
,MessageChannel
- All Known Implementing Classes:
AssembledConnectedMessageChannel
,AssembledMessageChannel
,ConduitWritableMessageChannel
,FramedMessageChannel
A channel that can send messages.
-
Field Summary
Fields inherited from interface org.xnio.channels.Configurable
EMPTY
-
Method Summary
Modifier and TypeMethodDescriptionChannelListener.Setter<? extends WritableMessageChannel>
Get the setter which can be used to change the close listener for this channel.ChannelListener.Setter<? extends WritableMessageChannel>
Get the setter which can be used to change the write listener for this channel.boolean
send
(ByteBuffer buffer) Send a complete message.boolean
send
(ByteBuffer[] buffers) Send a complete message.boolean
send
(ByteBuffer[] buffers, int offs, int len) Send a complete message.boolean
sendFinal
(ByteBuffer buffer) Send a complete message.boolean
sendFinal
(ByteBuffer[] buffers) Send a complete message.boolean
sendFinal
(ByteBuffer[] buffers, int offs, int len) Send a complete message.Methods inherited from interface org.xnio.channels.CloseableChannel
getIoThread, getWorker
Methods inherited from interface org.xnio.channels.Configurable
getOption, setOption, supportsOption
Methods inherited from interface org.xnio.channels.SuspendableWriteChannel
awaitWritable, awaitWritable, close, flush, getWriteThread, isOpen, isWriteResumed, resumeWrites, shutdownWrites, suspendWrites, wakeupWrites
-
Method Details
-
send
Send a complete message.- Parameters:
buffer
- the message to send- Returns:
- the result of the send operation;
true
if the message was sent, orfalse
if it would block - Throws:
IOException
- if an I/O error occurs
-
send
Send a complete message.- Parameters:
buffers
- the buffers holding the message to send- Returns:
- the result of the send operation;
true
if the message was sent, orfalse
if it would block - Throws:
IOException
- if an I/O error occurs
-
send
Send a complete message.- Parameters:
buffers
- the buffers holding the message to sendoffs
- the offset into the buffer array of the first bufferlen
- the number of buffers that contain data to send- Returns:
- the result of the send operation;
true
if the message was sent, orfalse
if it would block - Throws:
IOException
- if an I/O error occurs
-
sendFinal
Send a complete message. If the message was successfully sent the channel with have its writes shutdown.- Parameters:
buffer
- the message to send- Returns:
- the result of the send operation;
true
if the message was sent, orfalse
if it would block - Throws:
IOException
- if an I/O error occurs
-
sendFinal
Send a complete message. If the message was successfully sent the channel with have its writes shutdown.- Parameters:
buffers
- the buffers holding the message to send- Returns:
- the result of the send operation;
true
if the message was sent, orfalse
if it would block - Throws:
IOException
- if an I/O error occurs
-
sendFinal
Send a complete message. If the message was successfully sent the channel with have its writes shutdown.- Parameters:
buffers
- the buffers holding the message to sendoffs
- the offset into the buffer array of the first bufferlen
- the number of buffers that contain data to send- Returns:
- the result of the send operation;
true
if the message was sent, orfalse
if it would block - Throws:
IOException
- if an I/O error occurs
-
getWriteSetter
ChannelListener.Setter<? extends WritableMessageChannel> getWriteSetter()Get the setter which can be used to change the write listener for this channel.- Specified by:
getWriteSetter
in interfaceSuspendableWriteChannel
- Returns:
- the setter
-
getCloseSetter
ChannelListener.Setter<? extends WritableMessageChannel> 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.- Specified by:
getCloseSetter
in interfaceCloseableChannel
- Specified by:
getCloseSetter
in interfaceSuspendableWriteChannel
- Returns:
- the setter
-