io.undertow.websockets.core

Class FixedPayloadFrameSourceChannel

java.lang.Object

io.undertow.server.protocol.framed.AbstractFramedStreamSourceChannel<WebSocketChannel,StreamSourceFrameChannel,StreamSinkFrameChannel>

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

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

type

Fields inherited from interface org.xnio.channels.Configurable

EMPTY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FixedPayloadFrameSourceChannel(WebSocketChannel wsChannel, WebSocketFrameType type, long payloadSize, int rsv, boolean finalFragment, org.xnio.Pooled<ByteBuffer> pooled, long frameLength, ChannelFunction... functions)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	afterRead(ByteBuffer buffer, int position, int length) Called after data was read into the ByteBuffer
protected void	handleHeaderData(FrameHeaderData headerData)
int	read(ByteBuffer dst)
long	read(ByteBuffer[] dsts)
long	read(ByteBuffer[] dsts, int offset, int length)
long	transferTo(long count, ByteBuffer throughBuffer, org.xnio.channels.StreamSinkChannel target)
long	transferTo(long position, long count, FileChannel target)

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

discard, finalFrame, getFramedChannel, getRsv, getType, getWebSocketChannel, isFinalFragment

Methods inherited from class io.undertow.server.protocol.framed.AbstractFramedStreamSourceChannel

awaitReadable, awaitReadable, close, complete, getCloseSetter, getIoThread, getOption, getReadFrameCount, getReadSetter, getReadThread, getWorker, isComplete, isOpen, isReadResumed, lastFrame, resumeReads, setOption, shutdownReads, supportsOption, suspendReads, 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 wsChannel,
                              WebSocketFrameType type,
                              long payloadSize,
                              int rsv,
                              boolean finalFragment,
                              org.xnio.Pooled<ByteBuffer> pooled,
                              long frameLength,
                              ChannelFunction... functions)

Method Detail

handleHeaderData

protected void handleHeaderData(FrameHeaderData headerData)

Overrides:

handleHeaderData in class AbstractFramedStreamSourceChannel<WebSocketChannel,StreamSourceFrameChannel,StreamSinkFrameChannel>

transferTo

public final long transferTo(long position,
              long count,
              FileChannel target)
                      throws IOException

Specified by:

transferTo in interface org.xnio.channels.StreamSourceChannel

Overrides:

transferTo in class AbstractFramedStreamSourceChannel<WebSocketChannel,StreamSourceFrameChannel,StreamSinkFrameChannel>

Throws:

IOException

transferTo

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

Specified by:

transferTo in interface org.xnio.channels.StreamSourceChannel

Overrides:

transferTo in class AbstractFramedStreamSourceChannel<WebSocketChannel,StreamSourceFrameChannel,StreamSinkFrameChannel>

Throws:

IOException

read

public int read(ByteBuffer dst)
         throws IOException

Specified by:

read in interface ReadableByteChannel

Overrides:

read in class AbstractFramedStreamSourceChannel<WebSocketChannel,StreamSourceFrameChannel,StreamSinkFrameChannel>

Throws:

IOException

read

public final long read(ByteBuffer[] dsts)
                throws IOException

Specified by:

read in interface ScatteringByteChannel

Overrides:

read in class AbstractFramedStreamSourceChannel<WebSocketChannel,StreamSourceFrameChannel,StreamSinkFrameChannel>

Throws:

IOException

read

public long read(ByteBuffer[] dsts,
        int offset,
        int length)
          throws IOException

Specified by:

read in interface ScatteringByteChannel

Overrides:

read in class AbstractFramedStreamSourceChannel<WebSocketChannel,StreamSourceFrameChannel,StreamSinkFrameChannel>

Throws:

IOException

afterRead

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

Called 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 occurs