io.undertow.server.protocol.framed

Class AbstractFramedChannel<C extends AbstractFramedChannel<C,R,S>,R extends AbstractFramedStreamSourceChannel<C,R,S>,S extends AbstractFramedStreamSinkChannel<C,R,S>>

java.lang.Object

io.undertow.server.protocol.framed.AbstractFramedChannel<C,R,S>

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, InterruptibleChannel, BoundChannel, CloseableChannel, Configurable, ConnectedChannel

Direct Known Subclasses:

AjpClientChannel, Http2Channel, WebSocketChannel

public abstract class AbstractFramedChannel<C extends AbstractFramedChannel<C,R,S>,R extends AbstractFramedStreamSourceChannel<C,R,S>,S extends AbstractFramedStreamSinkChannel<C,R,S>>
extends Object
implements ConnectedChannel

A ConnectedChannel which can be used to send and receive Frames.

This provides a common base for framed protocols such as websockets and SPDY

Author:

Stuart Douglas

Field Summary

Fields inherited from interface org.xnio.channels.Configurable

EMPTY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFramedChannel(StreamConnection connectedStreamChannel, ByteBufferPool bufferPool, FramePriority<C,R,S> framePriority, PooledByteBuffer readData, OptionMap settings) Create a new AbstractFramedChannel 8

Method Summary

Modifier and Type	Method and Description
void	addCloseTask(ChannelListener<C> task)
void	close() Forcibly closes the AbstractFramedChannel.
protected abstract void	closeSubChannels() Method that is called when the channel is being forcibly closed, and all sub stream sink/source channels should also be forcibly closed.
protected abstract R	createChannel(FrameHeaderData frameHeaderData, PooledByteBuffer frameData) Method that creates the actual stream source channel implementation that is in use.
protected IdleTimeoutConduit	createIdleTimeoutChannel(StreamConnection connectedStreamChannel)
void	flush()
protected void	flushSenders() Flushes all ready stream sink conduits to the channel.
ByteBufferPool	getBufferPool() Get the buffer pool for this connection.
ChannelListener.Setter<? extends AbstractFramedChannel>	getCloseSetter() Get the setter which can be used to change the close listener for this channel.
InetSocketAddress	getDestinationAddress() Get the destination address of the Channel.
protected FramePriority<C,R,S>	getFramePriority()
long	getIdleTimeout()
XnioIoThread	getIoThread() Get the I/O thread associated with this channel.
SocketAddress	getLocalAddress() Get the local address that this channel is bound to.
<A extends SocketAddress> A	getLocalAddress(Class<A> type) Get the local address of a given type, or null if the address is not of that type.
<T> T	getOption(Option<T> option) Get the value of a channel option.
SocketAddress	getPeerAddress() Get the peer address of this channel.
<A extends SocketAddress> A	getPeerAddress(Class<A> type) Get the peer address of a given type, or null if the address is not of that type.
ChannelListener.Setter<C>	getReceiveSetter() Return the ChannelListener.Setter which will holds the ChannelListener that gets notified once a frame was received.
protected OptionMap	getSettings()
InetSocketAddress	getSourceAddress() Get the source address of the Channel.
protected StreamConnection	getUnderlyingConnection()
XnioWorker	getWorker() Get the worker for this channel.
protected abstract void	handleBrokenSinkChannel(Throwable e) Method that is invoked when then write side of a channel is broken.
protected abstract void	handleBrokenSourceChannel(Throwable e) Method that is invoked when the read side of the channel is broken.
protected abstract boolean	isLastFrameReceived() Returns true if the protocol specific final frame has been received.
protected abstract boolean	isLastFrameSent()
boolean	isOpen()
protected boolean	isReadsBroken()
boolean	isReceivesResumed()
boolean	isRequireExplicitFlush()
protected boolean	isWritesBroken()
protected void	lastDataRead() Method than is invoked when read() returns -1.
protected void	markReadsBroken(Throwable cause) Called when a source sub channel fails to fulfil its contract, and leaves the channel in an inconsistent state.
protected void	markWritesBroken(Throwable cause) Called when a sub channel fails to fulfil its contract, and leaves the channel in an inconsistent state.
protected abstract FrameHeaderData	parseFrame(ByteBuffer data) Attempts to parse an incoming frame header from the data in the buffer.
protected void	queueFrame(S channel) Queues a new frame to be sent, and attempts a flush if this is the first frame in the new frame queue.
protected void	recalculateHeldFrames()
R	receive() receive method, returns null if no frame is ready.
void	resumeReceives() Resume the receive of new frames via receive()
void	setIdleTimeout(long timeout)
<T> T	setOption(Option<T> option, T value) Set an option for this channel.
void	setRequireExplicitFlush(boolean requireExplicitFlush)
boolean	supportsOption(Option<?> option) Determine whether an option is supported on this channel.
void	suspendReceives() Suspend the receive of new frames via receive()
String	toString()
protected ChannelExceptionHandler<SuspendableWriteChannel>	writeExceptionHandler()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractFramedChannel

protected AbstractFramedChannel(StreamConnection connectedStreamChannel,
                                ByteBufferPool bufferPool,
                                FramePriority<C,R,S> framePriority,
                                PooledByteBuffer readData,
                                OptionMap settings)

Create a new AbstractFramedChannel 8

Parameters:

connectedStreamChannel - The ConnectedStreamChannel over which the Frames should get send and received. Be aware that it already must be "upgraded".

bufferPool - The ByteBufferPool which will be used to acquire ByteBuffer's from.

framePriority -

settings - The settings

Method Detail

createIdleTimeoutChannel

protected IdleTimeoutConduit createIdleTimeoutChannel(StreamConnection connectedStreamChannel)

getBufferPool

public ByteBufferPool getBufferPool()

Get the buffer pool for this connection.

Returns:

the buffer pool for this connection

getLocalAddress

public SocketAddress getLocalAddress()

Description copied from interface: BoundChannel

Get the local address that this channel is bound to.

Specified by:

getLocalAddress in interface BoundChannel

Returns:

the local address

getLocalAddress

public <A extends SocketAddress> A getLocalAddress(Class<A> type)

Description copied from interface: BoundChannel

Get the local address of a given type, or null if the address is not of that type.

Specified by:

getLocalAddress in interface BoundChannel

Type Parameters:

A - the address type

Parameters:

type - the address type class

Returns:

the local address, or null if unknown

getWorker

public XnioWorker getWorker()

Description copied from interface: CloseableChannel

Get the worker for this channel.

Specified by:

getWorker in interface CloseableChannel

Returns:

the worker

getIoThread

public XnioIoThread getIoThread()

Description copied from interface: CloseableChannel

Get the I/O thread associated with this channel.

Specified by:

getIoThread in interface CloseableChannel

Returns:

the I/O thread associated with this channel

supportsOption

public boolean supportsOption(Option<?> option)

Description copied from interface: Configurable

Determine whether an option is supported on this channel.

Specified by:

supportsOption in interface Configurable

Parameters:

option - the option

Returns:

true if it is supported

getOption

public <T> T getOption(Option<T> option)
                throws IOException

Description copied from interface: Configurable

Get the value of a channel option.

Specified by:

getOption in interface Configurable

Type Parameters:

T - the type of the option value

Parameters:

option - the option to get

Returns:

the value of the option, or null if it is not set

Throws:

IOException - if an I/O error occurred when reading the option

setOption

public <T> T setOption(Option<T> option,
                       T value)
                throws IOException

Description copied from interface: Configurable

Set an option for this channel. Unsupported options are ignored.

Specified by:

setOption in interface Configurable

Type Parameters:

T - the type of the option value

Parameters:

option - the option to set

value - the value of the option to set

Returns:

the previous option value, if any

Throws:

IOException - if an I/O error occurred when modifying the option

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Channel

getPeerAddress

public SocketAddress getPeerAddress()

Description copied from interface: ConnectedChannel

Get the peer address of this channel.

Specified by:

getPeerAddress in interface ConnectedChannel

Returns:

the peer address

getPeerAddress

public <A extends SocketAddress> A getPeerAddress(Class<A> type)

Description copied from interface: ConnectedChannel

Get the peer address of a given type, or null if the address is not of that type.

Specified by:

getPeerAddress in interface ConnectedChannel

Parameters:

type - the address type class

Returns:

the peer address, or null if unknown

getSourceAddress

public InetSocketAddress getSourceAddress()

Get the source address of the Channel.

Returns:

the source address of the Channel

getDestinationAddress

public InetSocketAddress getDestinationAddress()

Get the destination address of the Channel.

Returns:

the destination address of the Channel

receive

public R receive()
          throws IOException

receive method, returns null if no frame is ready. Otherwise returns a channel that can be used to read the frame contents.

Calling this method can also have the side effect of making additional data available to existing source channels. In general if you suspend receives or don't have some other way of calling this method then it can prevent frame channels for being fully consumed.

Throws:

IOException

lastDataRead

protected void lastDataRead()

Method than is invoked when read() returns -1.

createChannel

protected abstract R createChannel(FrameHeaderData frameHeaderData,
                                   PooledByteBuffer frameData)
                            throws IOException

Method that creates the actual stream source channel implementation that is in use.

Parameters:

frameHeaderData - The header data, as returned by parseFrame(java.nio.ByteBuffer)

frameData - Any additional data for the frame that has already been read. This may not be the complete frame contents

Returns:

A new stream source channel

Throws:

IOException

parseFrame

protected abstract FrameHeaderData parseFrame(ByteBuffer data)
                                       throws IOException

Attempts to parse an incoming frame header from the data in the buffer.

Parameters:

data - The data that has been read from the channel

Returns:

The frame header data, or null if the data was incomplete

Throws:

IOException - If the data could not be parsed.

recalculateHeldFrames

protected void recalculateHeldFrames()
                              throws IOException

Throws:

IOException

flushSenders

protected void flushSenders()

Flushes all ready stream sink conduits to the channel.

Frames will be batched up, to allow them all to be written out via a gathering write. The framePriority implementation will be invoked to decide which frames are eligible for sending and in what order.

queueFrame

protected void queueFrame(S channel)
                   throws IOException

Queues a new frame to be sent, and attempts a flush if this is the first frame in the new frame queue.

Depending on the FramePriority implementation in use the channel may or may not be added to the actual pending queue

Parameters:

channel - The channel

Throws:

IOException

flush

public void flush()

isLastFrameReceived

protected abstract boolean isLastFrameReceived()

Returns true if the protocol specific final frame has been received.

Returns:

true If the last frame has been received

isLastFrameSent

protected abstract boolean isLastFrameSent()

Returns:

true If the last frame has been sent

handleBrokenSourceChannel

protected abstract void handleBrokenSourceChannel(Throwable e)

Method that is invoked when the read side of the channel is broken. This generally happens on a protocol error.

handleBrokenSinkChannel

protected abstract void handleBrokenSinkChannel(Throwable e)

Method that is invoked when then write side of a channel is broken. This generally happens on a protocol error.

getReceiveSetter

public ChannelListener.Setter<C> getReceiveSetter()

Return the ChannelListener.Setter which will holds the ChannelListener that gets notified once a frame was received.

suspendReceives

public void suspendReceives()

Suspend the receive of new frames via receive()

resumeReceives

public void resumeReceives()

Resume the receive of new frames via receive()

isReceivesResumed

public boolean isReceivesResumed()

close

public void close()
           throws IOException

Forcibly closes the AbstractFramedChannel.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Channel

Specified by:

close in interface InterruptibleChannel

Specified by:

close in interface CloseableChannel

Throws:

IOException - if the close failed

getCloseSetter

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

Description copied from interface: ConnectedChannel

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 interface BoundChannel

Specified by:

getCloseSetter in interface CloseableChannel

Specified by:

getCloseSetter in interface ConnectedChannel

Returns:

the setter

markReadsBroken

protected void markReadsBroken(Throwable cause)

Called when a source sub channel fails to fulfil its contract, and leaves the channel in an inconsistent state.

The underlying read side will be forcibly closed.

Parameters:

cause - The possibly null cause

closeSubChannels

protected abstract void closeSubChannels()

Method that is called when the channel is being forcibly closed, and all sub stream sink/source channels should also be forcibly closed.

markWritesBroken

protected void markWritesBroken(Throwable cause)

Called when a sub channel fails to fulfil its contract, and leaves the channel in an inconsistent state.

The underlying channel will be closed, and any sub channels that have writes resumed will have their listeners notified. It is expected that these listeners will then attempt to use the channel, and their standard error handling logic will take over.

Parameters:

cause - The possibly null cause

isWritesBroken

protected boolean isWritesBroken()

isReadsBroken

protected boolean isReadsBroken()

setIdleTimeout

public void setIdleTimeout(long timeout)

getIdleTimeout

public long getIdleTimeout()

getFramePriority

protected FramePriority<C,R,S> getFramePriority()

addCloseTask

public void addCloseTask(ChannelListener<C> task)

toString

public String toString()

Overrides:

toString in class Object

getUnderlyingConnection

protected StreamConnection getUnderlyingConnection()

writeExceptionHandler

protected ChannelExceptionHandler<SuspendableWriteChannel> writeExceptionHandler()

isRequireExplicitFlush

public boolean isRequireExplicitFlush()

setRequireExplicitFlush

public void setRequireExplicitFlush(boolean requireExplicitFlush)

getSettings

protected OptionMap getSettings()