Jetty 12.0.6 · org.eclipse.jetty.websocket.core.messages.MessageReader

Modifier and Type	Field and Description
private final ByteBuffer	buffer
private final MessageInputStream	stream
private final CharsetDecoder	utf8Decoder

Access	Constructor and Description
public	MessageReader(CoreSession coreSession)

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	close() Implements abstract java.io.Reader.close. Implements java.io.Closeable.close. Closes the stream and releases any system resources associated with it.
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.
public int	read(char[] Destination buffer chars, int Offset at which to start storing characters off, int Maximum number of characters to read len) Implements abstract java.io.Reader.read. Reads characters into a portion of an array.

Inherited from java.io.Reader:: mark markSupported nullReader of read read read readAllAsString readAllLines ready reset skip transferTo

buffer	back to summary
private final ByteBuffer buffer

stream	back to summary
private final MessageInputStream stream

utf8Decoder	back to summary
private final CharsetDecoder utf8Decoder

MessageReader	back to summary
public MessageReader(CoreSession coreSession)

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

close	back to summary
public void close() throws IOException Implements abstract java.io.Reader.close. Implements java.io.Closeable.close. Doc from java.io.Reader.close. Closes the stream and releases any system resources associated with it. Once the stream has been closed, further read(), ready(), mark(), reset(), or skip() invocations will throw an IOException. Closing a previously closed stream has no effect. Annotations @Override Exceptions IOException: If an I/O error occurs

back to summary

public void close() throws IOException

Implements abstract java.io.Reader.close.

Implements java.io.Closeable.close.

Doc from java.io.Reader.close.

Closes the stream and releases any system resources associated with it. Once the stream has been closed, further read(), ready(), mark(), reset(), or skip() invocations will throw an IOException. Closing a previously closed stream has no effect.

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

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

read back to summary

read	back to summary
public int read(char[] chars, int off, int len) throws IOException Implements abstract java.io.Reader.read. Doc from java.io.Reader.read. Reads characters into a portion of an array. This method will block until some input is available, an I/O error occurs, or the end of the stream is reached. If `len` is zero, then no characters are read and `0` is returned; otherwise, there is an attempt to read at least one character. If no character is available because the stream is at its end, the value `-1` is returned; otherwise, at least one character is read and stored into `cbuf`. Parameters chars:char[] Destination buffer off:int Offset at which to start storing characters len:int Maximum number of characters to read Returns:int The number of characters read, or -1 if the end of the stream has been reached Annotations @Override Exceptions IOException: If an I/O error occurs

public int read(char[] chars, int off, int len) throws IOException

Implements abstract java.io.Reader.read.

Doc from java.io.Reader.read.

Reads characters into a portion of an array. This method will block until some input is available, an I/O error occurs, or the end of the stream is reached.

If len is zero, then no characters are read and 0 is returned; otherwise, there is an attempt to read at least one character. If no character is available because the stream is at its end, the value -1 is returned; otherwise, at least one character is read and stored into cbuf.

Parameters

chars:char[]: Destination buffer
off:int: Offset at which to start storing characters
len:int: Maximum number of characters to read

Returns:int

The number of characters read, or -1 if the end of the stream has been reached

Annotations

@Override

Exceptions

IOException:: If an I/O error occurs

public Class MessageReader

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail