io.undertow.websockets.core

Class FixedPayloadFrameSourceChannel

java.lang.Object

io.undertow.websockets.core.StreamSourceFrameChannel

io.undertow.websockets.core.FixedPayloadFrameSourceChannel

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, InterruptibleChannel, ReadableByteChannel, ScatteringByteChannel, org.xnio.channels.CloseableChannel, org.xnio.channels.Configurable, org.xnio.channels.StreamSourceChannel, org.xnio.channels.SuspendableReadChannel

Direct Known Subclasses:

WebSocket00BinaryFrameSourceChannel

public abstract class FixedPayloadFrameSourceChannel
extends StreamSourceFrameChannel

A StreamSourceFrameChannel that is used to read a Frame with a fixed sized payload.

Author:

Norman Maurer

Field Summary

Fields inherited from class io.undertow.websockets.core.StreamSourceFrameChannel

channel, type, wsChannel

Fields inherited from interface org.xnio.channels.Configurable

EMPTY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FixedPayloadFrameSourceChannel(WebSocketChannel.StreamSourceChannelControl streamSourceChannelControl, org.xnio.channels.StreamSourceChannel channel, WebSocketChannel wsChannel, WebSocketFrameType type, long payloadSize, int rsv, boolean finalFragment, ChannelFunction... functions)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	afterRead(ByteBuffer buffer, int position, int length) Caled after data was read into the ByteBuffer
protected void	complete() Is called once the whole frame was read.
protected boolean	isComplete() Returns true if the frame was complete.
protected int	read0(ByteBuffer dst)
protected long	read0(ByteBuffer[] dsts)
protected long	read0(ByteBuffer[] dsts, int offset, int length)
protected long	transferTo0(long count, ByteBuffer throughBuffer, org.xnio.channels.StreamSinkChannel target)
protected long	transferTo0(long position, long count, FileChannel target)

Methods inherited from class io.undertow.websockets.core.StreamSourceFrameChannel

awaitReadable, awaitReadable, close, discard, getCloseSetter, getIoThread, getOption, getPayloadSize, getReadSetter, getReadThread, getRsv, getType, getWebSocketChannel, getWorker, isFinalFragment, isOpen, isReadResumed, queueListener, read, read, read, resumeReads, setOption, shutdownReads, supportsOption, suspendReads, transferTo, transferTo, wakeupReads

Methods inherited from class java.lang.Object

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

Constructor Detail

FixedPayloadFrameSourceChannel

protected FixedPayloadFrameSourceChannel(WebSocketChannel.StreamSourceChannelControl streamSourceChannelControl,
                              org.xnio.channels.StreamSourceChannel channel,
                              WebSocketChannel wsChannel,
                              WebSocketFrameType type,
                              long payloadSize,
                              int rsv,
                              boolean finalFragment,
                              ChannelFunction... functions)

Method Detail

transferTo0

protected final long transferTo0(long position,
               long count,
               FileChannel target)
                          throws IOException

Specified by:

transferTo0 in class StreamSourceFrameChannel

Throws:

IOException

See Also:

StreamSourceChannel.transferTo(long, long, FileChannel)

transferTo0

protected final long transferTo0(long count,
               ByteBuffer throughBuffer,
               org.xnio.channels.StreamSinkChannel target)
                          throws IOException

Specified by:

transferTo0 in class StreamSourceFrameChannel

Throws:

IOException

See Also:

StreamSourceChannel.transferTo(long, ByteBuffer, StreamSinkChannel)

read0

protected int read0(ByteBuffer dst)
             throws IOException

Specified by:

read0 in class StreamSourceFrameChannel

Throws:

IOException

See Also:

ReadableByteChannel.read(ByteBuffer)

read0

protected final long read0(ByteBuffer[] dsts)
                    throws IOException

Specified by:

read0 in class StreamSourceFrameChannel

Throws:

IOException

See Also:

ScatteringByteChannel.read(ByteBuffer[])

read0

protected long read0(ByteBuffer[] dsts,
         int offset,
         int length)
              throws IOException

Specified by:

read0 in class StreamSourceFrameChannel

Throws:

IOException

See Also:

ScatteringByteChannel.read(ByteBuffer[], int, int)

isComplete

protected final boolean isComplete()

Description copied from class: StreamSourceFrameChannel

Returns true if the frame was complete.

Specified by:

isComplete in class StreamSourceFrameChannel

afterRead

protected void afterRead(ByteBuffer buffer,
             int position,
             int length)
                  throws IOException

Caled after data was read into the ByteBuffer

Parameters:

buffer - the ByteBuffer into which the data was read

position - the position it was written to

length - the number of bytes there were written

Throws:

IOException - thrown if an error accour

complete

protected void complete()
                 throws IOException

Description copied from class: StreamSourceFrameChannel

Is called once the whole frame was read.

Overrides:

complete in class StreamSourceFrameChannel

Throws:

IOException