java.lang.Object
org.xnio.channels.TranslatingSuspendableChannel<ConnectedMessageChannel,ConnectedStreamChannel>
org.xnio.channels.FramedMessageChannel
- All Implemented Interfaces:
Closeable
,AutoCloseable
,Channel
,InterruptibleChannel
,BoundChannel
,CloseableChannel
,CloseListenerSettable<ConnectedMessageChannel>
,Configurable
,ConnectedChannel
,ConnectedMessageChannel
,MessageChannel
,ReadableMessageChannel
,ReadListenerSettable<ConnectedMessageChannel>
,SuspendableChannel
,SuspendableReadChannel
,SuspendableWriteChannel
,WrappedChannel<ConnectedStreamChannel>
,WritableMessageChannel
,WriteListenerSettable<ConnectedMessageChannel>
@Deprecated
public class FramedMessageChannel
extends TranslatingSuspendableChannel<ConnectedMessageChannel,ConnectedStreamChannel>
implements ConnectedMessageChannel
Deprecated.
This class is deprecated; use conduits instead.
A connected message channel providing a SASL-style framing layer over a stream channel where each message is prepended
by a four-byte length field.
- Author:
- David M. Lloyd
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.xnio.channels.CloseListenerSettable
CloseListenerSettable.Setter<C extends Channel>
Nested classes/interfaces inherited from interface org.xnio.channels.ReadListenerSettable
ReadListenerSettable.Setter<C extends Channel>
Nested classes/interfaces inherited from interface org.xnio.channels.WriteListenerSettable
WriteListenerSettable.Setter<C extends Channel>
-
Field Summary
Fields inherited from class org.xnio.channels.TranslatingSuspendableChannel
channel
Fields inherited from interface org.xnio.channels.Configurable
EMPTY
-
Constructor Summary
ConstructorsConstructorDescriptionFramedMessageChannel
(ConnectedStreamChannel channel, ByteBuffer receiveBuffer, ByteBuffer transmitBuffer) Deprecated.Construct a new instance.FramedMessageChannel
(ConnectedStreamChannel channel, Pooled<ByteBuffer> receiveBuffer, Pooled<ByteBuffer> transmitBuffer) Deprecated.Construct a new instance. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
closeAction
(boolean readShutDown, boolean writeShutDown) Deprecated.The action to perform when the channel is closed via theTranslatingSuspendableChannel.close()
method.protected boolean
flushAction
(boolean shutDown) Deprecated.The action to perform when the channel is flushed.Deprecated.Get the underlying channel.Deprecated.Get the local address that this channel is bound to.<A extends SocketAddress>
AgetLocalAddress
(Class<A> type) Deprecated.Get the local address of a given type, ornull
if the address is not of that type.Deprecated.Get the peer address of this channel.<A extends SocketAddress>
AgetPeerAddress
(Class<A> type) Deprecated.Get the peer address of a given type, ornull
if the address is not of that type.int
receive
(ByteBuffer buffer) Deprecated.Receive a message.long
receive
(ByteBuffer[] buffers) Deprecated.Receive a message.long
receive
(ByteBuffer[] buffers, int offs, int len) Deprecated.Receive a message.boolean
send
(ByteBuffer buffer) Deprecated.Send a complete message.boolean
send
(ByteBuffer[] buffers) Deprecated.Send a complete message.boolean
send
(ByteBuffer[] buffers, int offs, int len) Deprecated.Send a complete message.boolean
sendFinal
(ByteBuffer buffer) Deprecated.Send a complete message.boolean
sendFinal
(ByteBuffer[] buffers) Deprecated.Send a complete message.boolean
sendFinal
(ByteBuffer[] buffers, int offs, int len) Deprecated.Send a complete message.protected void
shutdownReadsAction
(boolean writeComplete) Deprecated.The action to perform when reads are shut down.protected void
shutdownWritesComplete
(boolean readShutDown) Deprecated.Notification that the channel has successfully flushed after having shut down writes.Methods inherited from class org.xnio.channels.TranslatingSuspendableChannel
awaitReadable, awaitReadable, awaitWritable, awaitWritable, clearReadReady, clearReadRequiresWrite, clearWriteReady, clearWriteRequiresRead, close, flush, getCloseListener, getCloseSetter, getIoThread, getOption, getReadListener, getReadSetter, getReadThread, getWorker, getWriteListener, getWriteSetter, getWriteThread, handleClosed, handleReadable, handleWritable, isOpen, isReadResumed, isReadShutDown, isWriteComplete, isWriteResumed, isWriteShutDown, readRequiresWrite, removeReadRequiresExternal, removeWriteRequiresExternal, resumeReads, resumeWrites, setClosed, setCloseListener, setOption, setReadListener, setReadReady, setReadRequiresWrite, setReadShutDown, setWriteListener, setWriteReady, setWriteRequiresRead, setWriteShutDown, shutdownReads, shutdownWrites, shutdownWritesAction, supportsOption, suspendReads, suspendWrites, thisTyped, toString, tryAddReadRequiresExternal, tryAddWriteRequiresExternal, wakeupReads, wakeupWrites, writeRequiresRead
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
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.ConnectedMessageChannel
getCloseSetter, getReadSetter, getWriteSetter
Methods inherited from interface org.xnio.channels.SuspendableReadChannel
awaitReadable, awaitReadable, getReadThread, isReadResumed, resumeReads, shutdownReads, suspendReads, wakeupReads
Methods inherited from interface org.xnio.channels.SuspendableWriteChannel
awaitWritable, awaitWritable, close, flush, getWriteThread, isOpen, isWriteResumed, resumeWrites, shutdownWrites, suspendWrites, wakeupWrites
-
Constructor Details
-
FramedMessageChannel
public FramedMessageChannel(ConnectedStreamChannel channel, ByteBuffer receiveBuffer, ByteBuffer transmitBuffer) Deprecated.Construct a new instance.- Parameters:
channel
- the channel to wrapreceiveBuffer
- the receive buffer (should be direct)transmitBuffer
- the send buffer (should be direct)
-
FramedMessageChannel
public FramedMessageChannel(ConnectedStreamChannel channel, Pooled<ByteBuffer> receiveBuffer, Pooled<ByteBuffer> transmitBuffer) Deprecated.Construct a new instance.- Parameters:
channel
- the channel to wrapreceiveBuffer
- the receive buffer (should be direct)transmitBuffer
- the send buffer (should be direct)
-
-
Method Details
-
receive
Deprecated.Receive a message.- Specified by:
receive
in interfaceReadableMessageChannel
- Parameters:
buffer
- the buffer that will hold the message- Returns:
- the size of the received message, 0 if no message is available, and -1 if the message channel has reached an end-of-file condition
- Throws:
IOException
- if an I/O error occurs
-
receive
Deprecated.Receive a message.- Specified by:
receive
in interfaceReadableMessageChannel
- Parameters:
buffers
- the buffers that will hold the message- Returns:
- the size of the received message, 0 if no message is available, and -1 if the message channel has reached an end-of-file condition
- Throws:
IOException
- if an I/O error occurs
-
receive
Deprecated.Receive a message.- Specified by:
receive
in interfaceReadableMessageChannel
- Parameters:
buffers
- the buffers that will hold the messageoffs
- the offset into the array of buffers of the first buffer to read intolen
- the number of buffers to fill- Returns:
- the size of the received message, 0 if no message is available, and -1 if the message channel has reached an end-of-file condition
- Throws:
IOException
- if an I/O error occurs
-
shutdownReadsAction
Deprecated.Description copied from class:TranslatingSuspendableChannel
The action to perform when reads are shut down. By default, this method delegates to the underlying channel.- Overrides:
shutdownReadsAction
in classTranslatingSuspendableChannel<ConnectedMessageChannel,
ConnectedStreamChannel> - Throws:
IOException
- if an error occurs
-
send
Deprecated.Send a complete message.- Specified by:
send
in interfaceWritableMessageChannel
- 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
Deprecated.Send a complete message.- Specified by:
send
in interfaceWritableMessageChannel
- 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
Deprecated.Send a complete message.- Specified by:
send
in interfaceWritableMessageChannel
- 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
Deprecated.Description copied from interface:WritableMessageChannel
Send a complete message. If the message was successfully sent the channel with have its writes shutdown.- Specified by:
sendFinal
in interfaceWritableMessageChannel
- 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
Deprecated.Description copied from interface:WritableMessageChannel
Send a complete message. If the message was successfully sent the channel with have its writes shutdown.- Specified by:
sendFinal
in interfaceWritableMessageChannel
- 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
Deprecated.Description copied from interface:WritableMessageChannel
Send a complete message. If the message was successfully sent the channel with have its writes shutdown.- Specified by:
sendFinal
in interfaceWritableMessageChannel
- 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
-
flushAction
Deprecated.Description copied from class:TranslatingSuspendableChannel
The action to perform when the channel is flushed. By default, this method delegates to the underlying channel. If theshutDown
parameter is set, and this method returnstrue
, the underlying channel will be shut down and this method will never be called again (future calls toTranslatingSuspendableChannel.flush()
will flush the underlying channel until it returnstrue
).- Overrides:
flushAction
in classTranslatingSuspendableChannel<ConnectedMessageChannel,
ConnectedStreamChannel> - Parameters:
shutDown
-true
if the channel's write side has been shut down,false
otherwise- Returns:
true
if the flush succeeded,false
if it would block- Throws:
IOException
- if an error occurs
-
shutdownWritesComplete
Deprecated.Description copied from class:TranslatingSuspendableChannel
Notification that the channel has successfully flushed after having shut down writes. The underlying channel may not yet be fully flushed at this time.- Overrides:
shutdownWritesComplete
in classTranslatingSuspendableChannel<ConnectedMessageChannel,
ConnectedStreamChannel> - Parameters:
readShutDown
-true
if the read side was already shut down,false
otherwise- Throws:
IOException
- if an error occurs
-
closeAction
Deprecated.Description copied from class:TranslatingSuspendableChannel
The action to perform when the channel is closed via theTranslatingSuspendableChannel.close()
method. By default, the underlying channel is closed.- Overrides:
closeAction
in classTranslatingSuspendableChannel<ConnectedMessageChannel,
ConnectedStreamChannel> - Parameters:
readShutDown
- if reads were previously shut downwriteShutDown
- if writes were previously shut down- Throws:
IOException
- if an error occurs
-
getPeerAddress
Deprecated.Get the peer address of this channel.- Specified by:
getPeerAddress
in interfaceConnectedChannel
- Returns:
- the peer address
-
getPeerAddress
Deprecated.Get the peer address of a given type, ornull
if the address is not of that type.- Specified by:
getPeerAddress
in interfaceConnectedChannel
- Parameters:
type
- the address type class- Returns:
- the peer address, or
null
if unknown
-
getLocalAddress
Deprecated.Get the local address that this channel is bound to.- Specified by:
getLocalAddress
in interfaceBoundChannel
- Returns:
- the local address
-
getLocalAddress
Deprecated.Get the local address of a given type, ornull
if the address is not of that type.- Specified by:
getLocalAddress
in interfaceBoundChannel
- Type Parameters:
A
- the address type- Parameters:
type
- the address type class- Returns:
- the local address, or
null
if unknown
-
getChannel
Deprecated.Get the underlying channel.- Specified by:
getChannel
in interfaceWrappedChannel<ConnectedStreamChannel>
- Overrides:
getChannel
in classTranslatingSuspendableChannel<ConnectedMessageChannel,
ConnectedStreamChannel> - Returns:
- the underlying channel
-