Class StringMessageSink

java.lang.Object

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

org.eclipse.jetty.websocket.core.messages.StringMessageSink

All Implemented Interfaces:

MessageSink

public class StringMessageSink
extends AbstractMessageSink

A MessageSink implementation that accumulates TEXT frames into a message that is then delivered to the application function passed to the constructor in the form of a String.

Constructor Summary

Constructors

Constructor	Description
StringMessageSink(CoreSession session, MethodHandle methodHandle, boolean autoDemand)	Creates a new StringMessageSink.

Method Summary

Modifier and Type	Method	Description
void	accept(Frame frame, Callback callback)	Consumes the WebSocket frame, possibly asynchronously when this method has returned.
void	fail(Throwable failure)	Fails this MessageSink with the given cause.

Methods inherited from class AbstractMessageSink

autoDemand, getCoreSession, getMethodHandle, isAutoDemand

Methods inherited from class Object

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

Constructor Details

StringMessageSink

public StringMessageSink(CoreSession session,
 MethodHandle methodHandle,
 boolean autoDemand)

Creates a new StringMessageSink.

Parameters:

session - the WebSocket session

methodHandle - the application function to invoke when a new message has been assembled

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

fail

public void fail(Throwable failure)

Description copied from interface: MessageSink

Fails this MessageSink with the given cause.

Parameters:

failure - the cause of the failure