Top Description Methods
org.xnio.conduits

public Interface MessageSinkConduit

extends SinkConduit
Known Direct Implementers
org.xnio.conduits.SynchronizedMessageSinkConduit, org.xnio.sasl.SaslUnwrappingConduit, org.xnio.sasl.SaslWrappingConduit, org.xnio.conduits.AbstractMessageSinkConduit, org.xnio.conduits.FramingMessageSinkConduit
Imports
java.io.IOException, java.nio.ByteBuffer

A message sink conduit.
Author
David M. Lloyd

Method Summary

Modifier and TypeMethod and Description
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
src
)

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
srcs
,
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
src
)

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
srcs
,
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.conduits.SinkConduit:
awaitWritableawaitWritableflushgetWriteThreadisWriteResumedisWriteShutdownresumeWritessetWriteReadyHandlersuspendWritesterminateWritestruncateWriteswakeupWrites

Method Detail

sendback to summary
public boolean send(ByteBuffer src) throws IOException

Send a complete message.

Parameters
src: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
sendback to summary
public boolean send(ByteBuffer[] srcs, int offs, int len) throws IOException

Send a complete message.

Parameters
srcs: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
sendFinalback to summary
public boolean sendFinal(ByteBuffer src) throws IOException

Send a complete message. If the message is successfully sent then the sink will have its writes terminated.

Parameters
src: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
sendFinalback to summary
public boolean sendFinal(ByteBuffer[] srcs, int offs, int len) throws IOException

Send a complete message. If the message is successfully sent then the sink will have its writes terminated.

Parameters
srcs: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