Class PartialByteBufferMessageSink

java.lang.Object

org.eclipse.jetty.websocket.core.messages.AbstractMessageSink

org.eclipse.jetty.websocket.core.messages.PartialByteBufferMessageSink

All Implemented Interfaces:

MessageSink

public class PartialByteBufferMessageSink
extends AbstractMessageSink

A MessageSink implementation that delivers BINARY frames to the application function passed to the constructor in the form of a ByteBuffer.

Constructor Summary

Constructors

Constructor	Description
PartialByteBufferMessageSink(CoreSession session, MethodHolder methodHolder, boolean autoDemand)	Creates a new PartialByteBufferMessageSink.

Method Summary

Modifier and Type	Method	Description
void	accept(Frame frame, Callback callback)	Consumes the WebSocket frame, possibly asynchronously when this method has returned.
protected void	invoke(MethodHolder methodHolder, ByteBuffer byteBuffer, boolean fin, Callback callback)

Methods inherited from class AbstractMessageSink

autoDemand, getCoreSession, getMethodHolder, isAutoDemand

Methods inherited from class Object

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

Methods inherited from interface MessageSink

fail

Constructor Details

PartialByteBufferMessageSink

public PartialByteBufferMessageSink(CoreSession session,
 MethodHolder methodHolder,
 boolean autoDemand)

Creates a new PartialByteBufferMessageSink.

Parameters:

session - the WebSocket session

methodHolder - the application function to invoke when a new frame has arrived

autoDemand - whether this MessageSink manages demand automatically

Method Details

accept

public void accept(Frame frame,
 Callback callback)

Description copied from interface: MessageSink

Consumes the WebSocket frame, possibly asynchronously when this method has returned.

The callback argument must be completed when the frame payload is consumed.

The demand for more frames must be explicitly invoked, or arranged to be invoked asynchronously, by the implementation of this method, by calling CoreSession.demand().

Parameters:

frame - the frame to consume

callback - the callback to complete when the frame is consumed

invoke

protected void invoke(MethodHolder methodHolder,
 ByteBuffer byteBuffer,
 boolean fin,
 Callback callback)
               throws Throwable

Throws:

Throwable