Jetty 12.0.6 · org.eclipse.jetty.websocket.core.WebSocketCoreSession

Modifier and Type	Class and Description
private class	WebSocketCoreSession.Flusher
private class	WebSocketCoreSession.IncomingAdaptor
private class	WebSocketCoreSession.OutgoingAdaptor

Modifier and Type	Field and Description
private boolean	autoFragment
private final Behavior	behavior
private ClassLoader	classLoader
private final WebSocketComponents	components
private WebSocketConnection	connection
private final ExtensionStack	extensionStack
private final WebSocketCoreSession.Flusher	flusher
private final FrameHandler	handler
private Duration	idleTimeout
private int	inputBufferSize
private static final Logger	LOG
private long	maxBinaryMessageSize
private long	maxFrameSize
private int	maxOutgoingFrames
private long	maxTextMessageSize
private final Negotiated	negotiated
private static final CloseStatus	NO_CODE
private final AtomicInteger	numOutgoingFrames
private int	outputBufferSize
private final WebSocketSessionState	sessionState
private Duration	writeTimeout

Access	Constructor and Description
public	WebSocketCoreSession(FrameHandler handler, Behavior behavior, Negotiated negotiated, WebSocketComponents components)

Method Summary

Modifier and Type	Method and Description
public void	abort() Implements org.eclipse.jetty.websocket.core.CoreSession.abort. Issue a harsh abort of the underlying connection.
public void	close(Callback the callback to track close frame sent (or failed). callback) Implements org.eclipse.jetty.websocket.core.CoreSession.close. Initiate close handshake, no payload (no declared status code or reason phrase).
public void	close(int the status code (should be a valid status code that can be sent). statusCode, String optional reason phrase (will be truncated automatically by implementation to fit within limits of protocol). reason, Callback the callback to track close frame sent (or failed). callback) Implements org.eclipse.jetty.websocket.core.CoreSession.close. Initiate close handshake with provided status code and optional reason phrase.
public void	close(CloseStatus the close status containing (statusCode, reason, and optional `Throwable` cause). closeStatus, Callback the callback to track close frame sent (or failed). callback) Overrides default org.eclipse.jetty.websocket.core.CoreSession.close. Initiate close handshake with a provided `CloseStatus`.
private void	closeConnection(CloseStatus closeStatus, Callback callback)
public void	demand() Implements org.eclipse.jetty.websocket.core.CoreSession.demand. Manages flow control by indicating demand for a WebSocket frame.
public String	dump() Overrides default org.eclipse.jetty.util.component.Dumpable.dump.
public void	dump(Appendable The appendable to dump to out, String The indent to apply after any new lines. indent) Implements org.eclipse.jetty.util.component.Dumpable.dump. Dump this object (and children) into an Appendable using the provided indent after any new lines.
public void	flush(Callback callback) Implements org.eclipse.jetty.websocket.core.CoreSession.flush.
public Behavior	getBehavior() Implements org.eclipse.jetty.websocket.core.CoreSession.getBehavior.
public ByteBufferPool	getByteBufferPool() Implements org.eclipse.jetty.websocket.core.CoreSession.getByteBufferPool.
public ClassLoader	getClassLoader()
public WebSocketConnection	getConnection()
public Executor	getExecutor()
public ExtensionStack	getExtensionStack()
public FrameHandler	getHandler()
public Duration	getIdleTimeout() Implements org.eclipse.jetty.websocket.core.Configuration.getIdleTimeout. Get the Idle Timeout
public int	getInputBufferSize() Implements org.eclipse.jetty.websocket.core.Configuration.getInputBufferSize.
public SocketAddress	getLocalAddress() Implements org.eclipse.jetty.websocket.core.CoreSession.getLocalAddress. The Local Socket Address for the connection Do not assume that this will return a `InetSocketAddress` in all cases.
public long	getMaxBinaryMessageSize() Implements org.eclipse.jetty.websocket.core.Configuration.getMaxBinaryMessageSize.
public long	getMaxFrameSize() Implements org.eclipse.jetty.websocket.core.Configuration.getMaxFrameSize.
public int	getMaxOutgoingFrames() Implements org.eclipse.jetty.websocket.core.Configuration.getMaxOutgoingFrames. Get the maximum number of data frames allowed to be waiting to be sent at any one time.
public long	getMaxTextMessageSize() Implements org.eclipse.jetty.websocket.core.Configuration.getMaxTextMessageSize.
public List<ExtensionConfig>	getNegotiatedExtensions() Implements org.eclipse.jetty.websocket.core.CoreSession.getNegotiatedExtensions. The negotiated WebSocket Extension Configurations for this session.
public String	getNegotiatedSubProtocol() Implements org.eclipse.jetty.websocket.core.CoreSession.getNegotiatedSubProtocol.
public int	getOutputBufferSize() Implements org.eclipse.jetty.websocket.core.Configuration.getOutputBufferSize.
public Map<String, List<String>>	getParameterMap() Implements org.eclipse.jetty.websocket.core.CoreSession.getParameterMap. The parameter map (from URI Query) for the active session.
public String	getProtocolVersion() Implements org.eclipse.jetty.websocket.core.CoreSession.getProtocolVersion. The active `Sec-WebSocket-Version` (protocol version) in use.
public SocketAddress	getRemoteAddress() Implements org.eclipse.jetty.websocket.core.CoreSession.getRemoteAddress. The Remote Socket Address for the connection Do not assume that this will return a `InetSocketAddress` in all cases.
public URI	getRequestURI() Implements org.eclipse.jetty.websocket.core.CoreSession.getRequestURI. The active connection's Request URI.
public WebSocketComponents	getWebSocketComponents() Implements org.eclipse.jetty.websocket.core.CoreSession.getWebSocketComponents.
public Duration	getWriteTimeout() Implements org.eclipse.jetty.websocket.core.Configuration.getWriteTimeout. Get the Write Timeout
protected void	handle(Runnable the runnable to execute. runnable) Can be overridden to scope into the correct classloader before calling application code.
public boolean	isAutoFragment() Implements org.eclipse.jetty.websocket.core.Configuration.isAutoFragment.
public boolean	isClosed() Implements org.eclipse.jetty.websocket.core.CoreSession.isClosed.
public boolean	isInputOpen() Implements org.eclipse.jetty.websocket.core.CoreSession.isInputOpen.
public boolean	isOutputOpen() Implements org.eclipse.jetty.websocket.core.CoreSession.isOutputOpen.
public boolean	isRsv1Used() Implements org.eclipse.jetty.websocket.core.CoreSession.isRsv1Used.
public boolean	isRsv2Used() Implements org.eclipse.jetty.websocket.core.CoreSession.isRsv2Used.
public boolean	isRsv3Used() Implements org.eclipse.jetty.websocket.core.CoreSession.isRsv3Used.
public boolean	isSecure() Implements org.eclipse.jetty.websocket.core.CoreSession.isSecure. The active connection's Secure status indicator.
public void	onEof() Used to notify the `WebSocketCoreSession` that EOF has been read or the connection has been closed.
public void	onFrame(Frame the frame to process. frame, Callback the read completion. callback) Implements org.eclipse.jetty.websocket.core.IncomingFrames.onFrame. Process the incoming frame.
public void	onOpen() Used to notify the `WebSocketCoreSession` that the connection has been opened.
public void	processConnectionError(Throwable the cause cause, Callback the callback on completion of error handling callback) Process an Error that originated from the connection.
public void	processHandlerError(Throwable the cause cause, Callback the callback on completion of error handling callback) Process an Error that originated from the handler.
public void	sendFrame(Frame the frame to eventually write to the network layer. frame, Callback the callback to notify when the frame is written. callback, boolean the batch mode requested by the sender. batch) Implements org.eclipse.jetty.websocket.core.OutgoingFrames.sendFrame. A frame, and optional callback, intended for the network layer.
public void	setAutoFragment(boolean autoFragment) Implements org.eclipse.jetty.websocket.core.Configuration.setAutoFragment.
public void	setClassLoader(ClassLoader classLoader)
public void	setIdleTimeout(Duration the timeout duration (timeout <= 0 implies an infinite timeout) timeout) Implements org.eclipse.jetty.websocket.core.Configuration.setIdleTimeout. Set the Idle Timeout.
public void	setInputBufferSize(int inputBufferSize) Implements org.eclipse.jetty.websocket.core.Configuration.setInputBufferSize.
public void	setMaxBinaryMessageSize(long maxSize) Implements org.eclipse.jetty.websocket.core.Configuration.setMaxBinaryMessageSize.
public void	setMaxFrameSize(long maxFrameSize) Implements org.eclipse.jetty.websocket.core.Configuration.setMaxFrameSize.
public void	setMaxOutgoingFrames(int the max number of frames. maxOutgoingFrames) Implements org.eclipse.jetty.websocket.core.Configuration.setMaxOutgoingFrames. Set the maximum number of data frames allowed to be waiting to be sent at any one time.
public void	setMaxTextMessageSize(long maxSize) Implements org.eclipse.jetty.websocket.core.Configuration.setMaxTextMessageSize.
public void	setOutputBufferSize(int outputBufferSize) Implements org.eclipse.jetty.websocket.core.Configuration.setOutputBufferSize.
public void	setWebSocketConnection(WebSocketConnection the websocket connection. connection) Used to set the WebSocketConnection on this `WebSocketCoreSession`.
public void	setWriteTimeout(Duration the timeout duration (timeout <= 0 implies an infinite timeout) timeout) Implements org.eclipse.jetty.websocket.core.Configuration.setWriteTimeout. Set the Write Timeout.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

public Class WebSocketCoreSession

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary