org.eclipse.jetty.ee10.websocket.jakarta.common.messages

public abstract Class AbstractDecodedMessageSink

Class Inheritance

java.lang.Object
org.eclipse.jetty.ee10.websocket.jakarta.common.messages.AbstractDecodedMessageSink

All Implemented Interfaces

org.eclipse.jetty.websocket.core.messages.MessageSink

Known Direct Subclasses

org.eclipse.jetty.ee10.websocket.jakarta.common.messages.AbstractDecodedMessageSink.Basic, org.eclipse.jetty.ee10.websocket.jakarta.common.messages.AbstractDecodedMessageSink.Stream

Imports

java.lang.invoke.MethodHandle, java.util.List, java.util.stream.Collectors, jakarta.websocket.CloseReason, .Decoder, org.eclipse.jetty.ee10.websocket.jakarta.common.decoders.RegisteredDecoder, org.eclipse.jetty.util.Callback, org.eclipse.jetty.websocket.core.CoreSession, .Frame, org.eclipse.jetty.websocket.core.exception.CloseException, org.eclipse.jetty.websocket.core.messages.MessageSink, org.slf4j.Logger, .LoggerFactory

Nested and Inner Type Summary

Modifier and Type	Class and Description
public abstract static class	AbstractDecodedMessageSink.Basic<T extends Decoder>
public abstract static class	AbstractDecodedMessageSink.Stream<T extends Decoder>

Field Summary

Modifier and Type	Field and Description
private final MessageSink	_messageSink
private final MethodHandle	_methodHandle
private static final Logger	LOG

Constructor Summary

Access	Constructor and Description
public	AbstractDecodedMessageSink(CoreSession coreSession, MethodHandle methodHandle)

Method Summary

Modifier and Type	Method and Description
public void	accept(Frame the frame to consume frame, Callback the callback to complete when the frame is consumed callback) Implements org.eclipse.jetty.websocket.core.messages.MessageSink.accept. Consumes the WebSocket frame, possibly asynchronously when this method has returned.
public void	fail(Throwable the cause of the failure failure) Overrides default org.eclipse.jetty.websocket.core.messages.MessageSink.fail. Fails this `MessageSink` with the given cause.
pack-priv void	invoke(Object the decoded message. message) Invoke the MessageSink with the decoded message.
pack-priv abstract MessageSink	newMessageSink(CoreSession coreSession) Returns: a message sink which will first decode the message then pass it to `_methodHandle`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

_messageSink	back to summary
private final MessageSink _messageSink

_methodHandle	back to summary
private final MethodHandle _methodHandle

LOG	back to summary
private static final Logger LOG

Constructor Detail

AbstractDecodedMessageSink	back to summary
public AbstractDecodedMessageSink(CoreSession coreSession, MethodHandle methodHandle)

Method Detail

accept back to summary

accept	back to summary
public void accept(Frame frame, Callback callback) Implements org.eclipse.jetty.websocket.core.messages.MessageSink.accept. Doc from org.eclipse.jetty.websocket.core.messages.MessageSink.accept. 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:Frame the frame to consume callback:Callback the callback to complete when the frame is consumed Annotations @Override

public void accept(Frame frame, Callback callback)

Implements org.eclipse.jetty.websocket.core.messages.MessageSink.accept.

Doc from org.eclipse.jetty.websocket.core.messages.MessageSink.accept.

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:Frame: the frame to consume
callback:Callback: the callback to complete when the frame is consumed

Annotations

@Override

fail back to summary

fail	back to summary
public void fail(Throwable failure) Overrides default org.eclipse.jetty.websocket.core.messages.MessageSink.fail. Doc from org.eclipse.jetty.websocket.core.messages.MessageSink.fail. Fails this `MessageSink` with the given cause. Parameters failure:Throwable the cause of the failure Annotations @Override

public void fail(Throwable failure)

Overrides default org.eclipse.jetty.websocket.core.messages.MessageSink.fail.

Doc from org.eclipse.jetty.websocket.core.messages.MessageSink.fail.

Fails this MessageSink with the given cause.

Parameters

failure:Throwable: the cause of the failure

Annotations

@Override

invoke	back to summary
pack-priv void invoke(Object message) Invoke the MessageSink with the decoded message. Parameters message:Object the decoded message.

invoke

back to summary

pack-priv void invoke(Object message)

Invoke the MessageSink with the decoded message.

Parameters

message:Object: the decoded message.

newMessageSink	back to summary
pack-priv abstract MessageSink newMessageSink(CoreSession coreSession) throws Exception Returns:MessageSink a message sink which will first decode the message then pass it to `_methodHandle`. Exceptions Exception: for any error in creating the message sink.

org.eclipse.jetty.ee10.websocket.jakarta.common.messages back to summary

public abstract Class AbstractDecodedMessageSink.Basic<T extends Decoder>

Class Inheritance

extends AbstractDecodedMessageSink

java.lang.Object
org.eclipse.jetty.ee10.websocket.jakarta.common.messages.AbstractDecodedMessageSink
org.eclipse.jetty.ee10.websocket.jakarta.common.messages.AbstractDecodedMessageSink.Basic

Known Direct Subclasses

org.eclipse.jetty.ee10.websocket.jakarta.common.messages.DecodedBinaryMessageSink, org.eclipse.jetty.ee10.websocket.jakarta.common.messages.DecodedTextMessageSink

Field Summary

Modifier and Type	Field and Description
protected final List<T>	_decoders

Constructor Summary

Access	Constructor and Description
public	Basic(CoreSession coreSession, MethodHandle methodHandle, List<RegisteredDecoder> decoders)

Method Summary

Inherited from org.eclipse.jetty.ee10.websocket.jakarta.common.messages.AbstractDecodedMessageSink:: accept fail invoke newMessageSink

Field Detail

_decoders	back to summary
protected final List<T> _decoders

Constructor Detail

Basic	back to summary
public Basic(CoreSession coreSession, MethodHandle methodHandle, List<RegisteredDecoder> decoders)

org.eclipse.jetty.ee10.websocket.jakarta.common.messages back to summary

public abstract Class AbstractDecodedMessageSink.Stream<T extends Decoder>

Class Inheritance

extends AbstractDecodedMessageSink

java.lang.Object
org.eclipse.jetty.ee10.websocket.jakarta.common.messages.AbstractDecodedMessageSink
org.eclipse.jetty.ee10.websocket.jakarta.common.messages.AbstractDecodedMessageSink.Stream

Known Direct Subclasses

org.eclipse.jetty.ee10.websocket.jakarta.common.messages.DecodedBinaryStreamMessageSink, org.eclipse.jetty.ee10.websocket.jakarta.common.messages.DecodedTextStreamMessageSink

Field Summary

Modifier and Type	Field and Description
protected final T	_decoder

Constructor Summary

Access	Constructor and Description
public	Stream(CoreSession coreSession, MethodHandle methodHandle, List<RegisteredDecoder> decoders)

Method Summary

Inherited from org.eclipse.jetty.ee10.websocket.jakarta.common.messages.AbstractDecodedMessageSink:: accept fail invoke newMessageSink

Field Detail

_decoder	back to summary
protected final T _decoder

Constructor Detail

Stream	back to summary
public Stream(CoreSession coreSession, MethodHandle methodHandle, List<RegisteredDecoder> decoders)