io.undertow.websockets.core

Class WebSocketChannel

java.lang.Object

io.undertow.websockets.core.WebSocketChannel

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, InterruptibleChannel, org.xnio.channels.BoundChannel, org.xnio.channels.CloseableChannel, org.xnio.channels.Configurable, org.xnio.channels.ConnectedChannel

Direct Known Subclasses:

WebSocket00Channel, WebSocket07Channel

public abstract class WebSocketChannel
extends Object
implements org.xnio.channels.ConnectedChannel

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

Author:

Norman Maurer, Stuart Douglas

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	WebSocketChannel.PartialFrame Interface that represenets a channel that is in the process of being created
class	WebSocketChannel.StreamSourceChannelControl

Field Summary

Fields inherited from interface org.xnio.channels.Configurable

EMPTY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WebSocketChannel(org.xnio.StreamConnection connectedStreamChannel, org.xnio.Pool<ByteBuffer> bufferPool, WebSocketVersion version, String wsUrl, Set<String> subProtocols, boolean client, boolean extensionsSupported) Create a new WebSocketChannel 8

Method Summary

Methods

Modifier and Type	Method and Description
boolean	areExtensionsSupported() Returns true if extensions are supported by this WebSocket Channel.
void	close() Forcibly closes the WebSocketChannel.
protected abstract StreamSinkFrameChannel	createStreamSinkChannel(org.xnio.channels.StreamSinkChannel channel, WebSocketFrameType type, long payloadSize) Create a new StreamSinkFrameChannel which can be used to send a WebSocket Frame of the type WebSocketFrameType.
Object	getAttribute(String key)
org.xnio.Pool<ByteBuffer>	getBufferPool() Get the buffer pool for this connection.
org.xnio.ChannelListener.Setter<? extends WebSocketChannel>	getCloseSetter()
InetSocketAddress	getDestinationAddress() Get the destination address of the WebSocket Channel.
long	getIdleTimeout()
org.xnio.XnioIoThread	getIoThread()
SocketAddress	getLocalAddress()
<A extends SocketAddress> A	getLocalAddress(Class<A> type)
<T> T	getOption(org.xnio.Option<T> option)
SocketAddress	getPeerAddress()
<A extends SocketAddress> A	getPeerAddress(Class<A> type)
org.xnio.ChannelListener.Setter<WebSocketChannel>	getReceiveSetter() Return the ChannelListener.Setter which will holds the ChannelListener that gets notified once a frame was received.
String	getRequestScheme() Get the request URI scheme.
InetSocketAddress	getSourceAddress() Get the source address of the WebSocket Channel.
Set<String>	getSubProtocols() Returns an unmodifiable Set of the selected subprotocols if any.
String	getUrl() Return the URL of the WebSocket endpoint.
WebSocketVersion	getVersion() Return the WebSocketVersion which is used
org.xnio.XnioWorker	getWorker()
boolean	isClient()
boolean	isCloseFrameReceived()
boolean	isCloseFrameSent()
boolean	isOpen()
boolean	isSecure() Return true if this is handled via WebSocket Secure.
StreamSourceFrameChannel	receive() Async receive, returns null if no frame is ready.
protected abstract WebSocketChannel.PartialFrame	receiveFrame(WebSocketChannel.StreamSourceChannelControl streamSourceChannelControl) Create a new StreamSourceFrameChannel which can be used to read the data of the received WebSocket Frame
void	resumeReceives() Resume the receive of new frames via receive()
StreamSinkFrameChannel	send(WebSocketFrameType type, long payloadSize) Returns a new StreamSinkFrameChannel for sending the given WebSocketFrameType with the given payload.
void	sendClose() Send a Close frame without a payload
FragmentedMessageChannel	sendFragmentedBinary() Return a FragmentedMessageChannel which can be used t send a BINARY WebSocket message in fragments.
FragmentedMessageChannel	sendFragmentedText() Return a FragmentedMessageChannel which can be used t send a TEXT WebSocket message in fragments.
boolean	setAttribute(String key, Object value)
void	setIdleTimeout(long timeout)
<T> T	setOption(org.xnio.Option<T> option, T value)
boolean	supportsOption(org.xnio.Option<?> option)
void	suspendReceives() Suspend the receive of new frames via receive()

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketChannel

protected WebSocketChannel(org.xnio.StreamConnection connectedStreamChannel,
                org.xnio.Pool<ByteBuffer> bufferPool,
                WebSocketVersion version,
                String wsUrl,
                Set<String> subProtocols,
                boolean client,
                boolean extensionsSupported)

Create a new WebSocketChannel 8

Parameters:

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

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

version - The WebSocketVersion of the WebSocketChannel

wsUrl - The url for which the WebSocket00Channel was created.

client -

Method Detail

setAttribute

public final boolean setAttribute(String key,
                   Object value)

getAttribute

public final Object getAttribute(String key)

areExtensionsSupported

public boolean areExtensionsSupported()

Returns true if extensions are supported by this WebSocket Channel.

getSubProtocols

public Set<String> getSubProtocols()

Returns an unmodifiable Set of the selected subprotocols if any.

getBufferPool

public org.xnio.Pool<ByteBuffer> getBufferPool()

Get the buffer pool for this connection.

Returns:

the buffer pool for this connection

getLocalAddress

public SocketAddress getLocalAddress()

Specified by:

getLocalAddress in interface org.xnio.channels.BoundChannel

getLocalAddress

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

Specified by:

getLocalAddress in interface org.xnio.channels.BoundChannel

getWorker

public org.xnio.XnioWorker getWorker()

Specified by:

getWorker in interface org.xnio.channels.CloseableChannel

getIoThread

public org.xnio.XnioIoThread getIoThread()

Specified by:

getIoThread in interface org.xnio.channels.CloseableChannel

supportsOption

public boolean supportsOption(org.xnio.Option<?> option)

Specified by:

supportsOption in interface org.xnio.channels.Configurable

getOption

public <T> T getOption(org.xnio.Option<T> option)
            throws IOException

Specified by:

getOption in interface org.xnio.channels.Configurable

Throws:

IOException

setOption

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

Specified by:

setOption in interface org.xnio.channels.Configurable

Throws:

IOException

isOpen

public boolean isOpen()

Specified by:

isOpen in interface Channel

isCloseFrameReceived

public boolean isCloseFrameReceived()

isCloseFrameSent

public boolean isCloseFrameSent()

getPeerAddress

public SocketAddress getPeerAddress()

Specified by:

getPeerAddress in interface org.xnio.channels.ConnectedChannel

getPeerAddress

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

Specified by:

getPeerAddress in interface org.xnio.channels.ConnectedChannel

getRequestScheme

public String getRequestScheme()

Get the request URI scheme. Normally this is one of ws or wss.

Returns:

the request URI scheme

isSecure

public boolean isSecure()

Return true if this is handled via WebSocket Secure.

getUrl

public String getUrl()

Return the URL of the WebSocket endpoint.

Returns:

url The URL of the endpoint

getVersion

public WebSocketVersion getVersion()

Return the WebSocketVersion which is used

Returns:

version The WebSocketVersion which is in use

getSourceAddress

public InetSocketAddress getSourceAddress()

Get the source address of the WebSocket Channel.

Returns:

the source address of the WebSocket Channel

getDestinationAddress

public InetSocketAddress getDestinationAddress()

Get the destination address of the WebSocket Channel.

Returns:

the destination address of the WebSocket Channel

receive

public StreamSourceFrameChannel receive()
                                 throws IOException

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

Throws:

IOException

getReceiveSetter

public org.xnio.ChannelListener.Setter<WebSocketChannel> 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()

isClient

public boolean isClient()

resumeReceives

public void resumeReceives()

Resume the receive of new frames via receive()

close

public void close()
           throws IOException

Forcibly closes the WebSocketChannel. Generally clients will wish to use sendClose() for a clean shutdown

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 org.xnio.channels.CloseableChannel

Throws:

IOException

send

public final StreamSinkFrameChannel send(WebSocketFrameType type,
                          long payloadSize)
                                  throws IOException

Returns a new StreamSinkFrameChannel for sending the given WebSocketFrameType with the given payload. If this method is called multiple times, subsequent StreamSinkFrameChannel's will not be writable until all previous frames were completely written.

Parameters:

type - The WebSocketFrameType for which a StreamSinkChannel should be created

payloadSize - The size of the payload which will be included in the WebSocket Frame. This may be 0 if you want to transmit no payload at all.

Throws:

IOException

sendFragmentedText

public final FragmentedMessageChannel sendFragmentedText()

Return a FragmentedMessageChannel which can be used t send a TEXT WebSocket message in fragments. This means the first fragment will be send as TEXT frame and the following as CONTINUATION frames.

If this method is called multiple times, subsequent FragmentedMessageChannel's will not be writable until all previous frames were completely written.

sendFragmentedBinary

public final FragmentedMessageChannel sendFragmentedBinary()

Return a FragmentedMessageChannel which can be used t send a BINARY WebSocket message in fragments. This means the first fragment will be send as TEXT frame and the following as CONTINUATION frames.

If this method is called multiple times, subsequent FragmentedMessageChannel's will not be writable until all previous frames were completely written.

sendClose

public void sendClose()
               throws IOException

Send a Close frame without a payload

Throws:

IOException

getCloseSetter

public org.xnio.ChannelListener.Setter<? extends WebSocketChannel> getCloseSetter()

Specified by:

getCloseSetter in interface org.xnio.channels.BoundChannel

Specified by:

getCloseSetter in interface org.xnio.channels.CloseableChannel

Specified by:

getCloseSetter in interface org.xnio.channels.ConnectedChannel

receiveFrame

protected abstract WebSocketChannel.PartialFrame receiveFrame(WebSocketChannel.StreamSourceChannelControl streamSourceChannelControl)

Create a new StreamSourceFrameChannel which can be used to read the data of the received WebSocket Frame

Parameters:

streamSourceChannelControl@return - channel A StreamSourceFrameChannel will be used to read a Frame from. This will return null if the right StreamSourceFrameChannel could not be detected with the given buffer and so more data is needed.

createStreamSinkChannel

protected abstract StreamSinkFrameChannel createStreamSinkChannel(org.xnio.channels.StreamSinkChannel channel,
                                             WebSocketFrameType type,
                                             long payloadSize)

Create a new StreamSinkFrameChannel which can be used to send a WebSocket Frame of the type WebSocketFrameType.

Parameters:

channel - The StreamSinkChannel to wrap

type - The WebSocketFrameType of the WebSocketFrame which will be send over this StreamSinkFrameChannel

payloadSize - The size of the payload to transmit. May be 0 if non payload at all should be included.

setIdleTimeout

public void setIdleTimeout(long timeout)

getIdleTimeout

public long getIdleTimeout()