- ABNORMAL - Static variable in class org.snf4j.websocket.frame.CloseFrame
-
Reserved (value 1006) and MUST NOT be set as a status code in a Close control
frame by an endpoint.
- AbstractWebSocketHandler - Class in org.snf4j.websocket
-
- AbstractWebSocketHandler() - Constructor for class org.snf4j.websocket.AbstractWebSocketHandler
-
Constructs an unnamed Web Socket handler for server sessions with the default
configuration.
- AbstractWebSocketHandler(URI) - Constructor for class org.snf4j.websocket.AbstractWebSocketHandler
-
Constructs an unnamed Web Socket handler for client sessions with the default
configuration.
- AbstractWebSocketHandler(String) - Constructor for class org.snf4j.websocket.AbstractWebSocketHandler
-
Constructs a named Web Socket handler for server sessions with the default
configuration.
- AbstractWebSocketHandler(String, URI) - Constructor for class org.snf4j.websocket.AbstractWebSocketHandler
-
Constructs a named Web Socket handler for client sessions with the default
configuration.
- AbstractWebSocketHandler(IWebSocketSessionConfig) - Constructor for class org.snf4j.websocket.AbstractWebSocketHandler
-
Constructs an unnamed Web Socket handler with the specified configuration.
- AbstractWebSocketHandler(String, IWebSocketSessionConfig) - Constructor for class org.snf4j.websocket.AbstractWebSocketHandler
-
Constructs a named Web Socket handler with the specified configuration.
- AbstractWebSocketSessionFactory - Class in org.snf4j.websocket
-
- AbstractWebSocketSessionFactory() - Constructor for class org.snf4j.websocket.AbstractWebSocketSessionFactory
-
Constructs a factory that creates the basic Web Socket sessions.
- AbstractWebSocketSessionFactory(boolean) - Constructor for class org.snf4j.websocket.AbstractWebSocketSessionFactory
-
Constructs a factory that creates Web Socket sessions of the given type
(basic or SSL/TLS).
- acceptOffer(List<String>) - Method in class org.snf4j.websocket.extensions.compress.PerMessageDeflateExtension
-
- acceptOffer(List<String>) - Method in interface org.snf4j.websocket.extensions.IExtension
-
Called by the Web Socket server to accept the received extension negotiation
offer.
- acceptRequestUri(URI) - Method in class org.snf4j.websocket.DefaultWebSocketSessionConfig
-
Determines if a received Web Socket handshake request with given request URI
should be accepted by the server session associated with this configuration
object.
- acceptRequestUri(URI) - Method in interface org.snf4j.websocket.IWebSocketSessionConfig
-
Determines if a received Web Socket handshake request with given request URI
should be accepted by the server session associated with this configuration
object.
- added(ISession, ICodecPipeline) - Method in class org.snf4j.websocket.handshake.HandshakeEncoder
-
- addFragment(byte[]) - Method in class org.snf4j.websocket.frame.AggregatedBinaryFrame
-
- addFragment(byte[]) - Method in class org.snf4j.websocket.frame.AggregatedTextFrame
-
Adds a new payload data fragment for future aggregation.
- addFragment(byte[]) - Method in interface org.snf4j.websocket.frame.IAggregatedFrame
-
Adds a new payload data fragment for future aggregation.
- addValue(String, String) - Method in class org.snf4j.websocket.handshake.HandshakeFrame
-
Adds a value of the header field identified by the specified name.
- AggregatedBinaryFrame - Class in org.snf4j.websocket.frame
-
Aggregated Web Socket binary frame.
- AggregatedBinaryFrame(boolean, int, byte[]) - Constructor for class org.snf4j.websocket.frame.AggregatedBinaryFrame
-
Constructs an aggregated Web Socket binary frame.
- AggregatedTextFrame - Class in org.snf4j.websocket.frame
-
Aggregated Web Socket text frame.
- AggregatedTextFrame(boolean, int, byte[]) - Constructor for class org.snf4j.websocket.frame.AggregatedTextFrame
-
Constructs an aggregated Web Socket text frame.
- available(ISession, ByteBuffer, boolean) - Method in class org.snf4j.websocket.frame.FrameDecoder
-
- available(ISession, byte[], int, int) - Method in class org.snf4j.websocket.frame.FrameDecoder
-
- available(ISession, ByteBuffer, boolean) - Method in class org.snf4j.websocket.handshake.HandshakeDecoder
-
- available(ISession, byte[], int, int) - Method in class org.snf4j.websocket.handshake.HandshakeDecoder
-
- close(int) - Method in interface org.snf4j.websocket.IWebSocketSession
-
Writes the Web Socket close frame with given status code and then gently
closes this session.
- close(int, String) - Method in interface org.snf4j.websocket.IWebSocketSession
-
Writes the Web Socket close frame with given status code and reason and then
gently closes this session.
- close(int) - Method in class org.snf4j.websocket.SSLWebSocketSession
-
- close(int, String) - Method in class org.snf4j.websocket.SSLWebSocketSession
-
- close(int) - Method in class org.snf4j.websocket.WebSocketSession
-
- close(int, String) - Method in class org.snf4j.websocket.WebSocketSession
-
- closed(ServerSocketChannel) - Method in class org.snf4j.websocket.AbstractWebSocketSessionFactory
-
- CloseFrame - Class in org.snf4j.websocket.frame
-
Web Socket connection close frame.
- CloseFrame(int, byte[]) - Constructor for class org.snf4j.websocket.frame.CloseFrame
-
Constructs a Web Socket connection close frame.
- CloseFrame(byte[]) - Constructor for class org.snf4j.websocket.frame.CloseFrame
-
Constructs a Web Socket connection close frame with all reserved bits cleared.
- CloseFrame() - Constructor for class org.snf4j.websocket.frame.CloseFrame
-
Constructs an empty Web Socket connection close frame with all reserved bits
cleared.
- CloseFrame(int, int) - Constructor for class org.snf4j.websocket.frame.CloseFrame
-
Constructs a Web Socket connection close frame with the specified status
code.
- CloseFrame(int) - Constructor for class org.snf4j.websocket.frame.CloseFrame
-
Constructs a Web Socket connection close frame with the specified status code
and with all reserved bits cleared.
- CloseFrame(int, int, String) - Constructor for class org.snf4j.websocket.frame.CloseFrame
-
Constructs a Web Socket connection close frame with the specified status code
and reason text.
- CloseFrame(int, String) - Constructor for class org.snf4j.websocket.frame.CloseFrame
-
Constructs a Web Socket connection close frame with the specified status code,
reason text and with all reserved bit cleared.
- ContinuationFrame - Class in org.snf4j.websocket.frame
-
Web Socket continuation frame containing continuation text or binary data.
- ContinuationFrame(boolean, int, byte[]) - Constructor for class org.snf4j.websocket.frame.ContinuationFrame
-
Constructs a Web Socket continuation frame containing binary data.
- ContinuationFrame(byte[]) - Constructor for class org.snf4j.websocket.frame.ContinuationFrame
-
Constructs a Web Socket continuation frame containing binary data.
- ContinuationFrame() - Constructor for class org.snf4j.websocket.frame.ContinuationFrame
-
Constructs an empty Web Socket continuation frame.
- ContinuationFrame(boolean, int, String) - Constructor for class org.snf4j.websocket.frame.ContinuationFrame
-
Constructs a Web Socket continuation frame containing text data.
- ContinuationFrame(String) - Constructor for class org.snf4j.websocket.frame.ContinuationFrame
-
Constructs a Web Socket continuation frame containing text data.
- ControlFrame - Class in org.snf4j.websocket.frame
-
Base class for all Web Socket control frames.
- ControlFrame(Opcode, int, byte[]) - Constructor for class org.snf4j.websocket.frame.ControlFrame
-
Constructs a generic Web Socket control frame.
- ControlFrame(Opcode, byte[]) - Constructor for class org.snf4j.websocket.frame.ControlFrame
-
Constructs a generic Web Socket control frame with all reserved bits cleared.
- create(SocketChannel) - Method in class org.snf4j.websocket.AbstractWebSocketSessionFactory
-
Creates a Web Socket session for a newly accepted connection.
- createCodecExecutor() - Method in class org.snf4j.websocket.DefaultWebSocketSessionConfig
-
- createHandler(SocketChannel) - Method in class org.snf4j.websocket.AbstractWebSocketSessionFactory
-
Creates a Web Socket handler for a newly accepted connection.
- customizeHeaders(HandshakeRequest) - Method in class org.snf4j.websocket.DefaultWebSocketSessionConfig
-
Called when the Web Socket handshake request is ready to be sent and can be
now customized, if needed.
- customizeHeaders(HandshakeResponse) - Method in class org.snf4j.websocket.DefaultWebSocketSessionConfig
-
Called when the Web Socket handshake response is ready to be sent and can be
now customized, if needed.
- customizeHeaders(HandshakeRequest) - Method in interface org.snf4j.websocket.IWebSocketSessionConfig
-
Called when the Web Socket handshake request is ready to be sent and can be
now customized, if needed.
- customizeHeaders(HandshakeResponse) - Method in interface org.snf4j.websocket.IWebSocketSessionConfig
-
Called when the Web Socket handshake response is ready to be sent and can be
now customized, if needed.
- getCloseType() - Method in exception org.snf4j.websocket.frame.InvalidFrameException
-
- getCloseType() - Method in exception org.snf4j.websocket.handshake.InvalidHandshakeException
-
- getClosingCause() - Method in exception org.snf4j.websocket.frame.InvalidFrameException
-
- getClosingCause() - Method in exception org.snf4j.websocket.handshake.InvalidHandshakeException
-
- getClosingReason() - Method in class org.snf4j.websocket.handshake.Handshaker
-
- getClosingReason() - Method in interface org.snf4j.websocket.handshake.IHandshaker
-
Returns a detailed reason why the handshake phase could not finished
successfully.
- getConfig() - Method in class org.snf4j.websocket.AbstractWebSocketHandler
-
Returns the Web Socket configuration object that will be used to configure
the behavior of the associated session.
- getConfig() - Method in interface org.snf4j.websocket.IWebSocketHandler
-
- getExtension(String) - Method in class org.snf4j.websocket.handshake.Handshaker
-
- getExtension(String) - Method in interface org.snf4j.websocket.handshake.IHandshaker
-
Returns the negotiated extension identified by the specified name.
- getExtensionNames() - Method in class org.snf4j.websocket.handshake.Handshaker
-
- getExtensionNames() - Method in interface org.snf4j.websocket.handshake.IHandshaker
-
Returns the names of all extensions that have been negotiated
- getExtensions() - Method in class org.snf4j.websocket.handshake.Handshaker
-
- getExtensions() - Method in interface org.snf4j.websocket.handshake.IHandshaker
-
Returns all extensions that have been negotiated
- getFragments() - Method in class org.snf4j.websocket.frame.AggregatedBinaryFrame
-
- getFragments() - Method in class org.snf4j.websocket.frame.AggregatedTextFrame
-
- getFragments() - Method in interface org.snf4j.websocket.frame.IAggregatedFrame
-
Returns all payload data fragments already stored in this frame.
- getGroupId() - Method in class org.snf4j.websocket.extensions.compress.PerMessageDeflateExtension
-
Returns an object that identifies the group to which the extension belongs.
- getGroupId() - Method in interface org.snf4j.websocket.extensions.IExtension
-
Returns an object that identifies the group to which the extension belongs.
- getHandshaker() - Method in interface org.snf4j.websocket.IWebSocketSession
-
Returns the Web Socket handshaker associated with this session.
- getHandshaker() - Method in class org.snf4j.websocket.SSLWebSocketSession
-
- getHandshaker() - Method in class org.snf4j.websocket.WebSocketSession
-
- getInboundType() - Method in class org.snf4j.websocket.frame.FrameAggregator
-
- getInboundType() - Method in class org.snf4j.websocket.frame.FrameDecoder
-
- getInboundType() - Method in class org.snf4j.websocket.frame.FrameEncoder
-
- getInboundType() - Method in class org.snf4j.websocket.frame.FrameUtf8Validator
-
- getInboundType() - Method in class org.snf4j.websocket.handshake.HandshakeDecoder
-
- getInboundType() - Method in class org.snf4j.websocket.handshake.HandshakeEncoder
-
- getMaxFramePayloadLength() - Method in class org.snf4j.websocket.DefaultWebSocketSessionConfig
-
Determines the maximum length of the payload in the decoded Web Socket
frames.
- getMaxFramePayloadLength() - Method in interface org.snf4j.websocket.IWebSocketSessionConfig
-
Determines the maximum length of the payload in the decoded Web Socket
frames.
- getMaxHandshakeFrameLength() - Method in class org.snf4j.websocket.DefaultWebSocketSessionConfig
-
Determines the maximum length of the decoded Web Socket handshake frames.
- getMaxHandshakeFrameLength() - Method in interface org.snf4j.websocket.IWebSocketSessionConfig
-
Determines the maximum length of the decoded Web Socket handshake frames.
- getName() - Method in class org.snf4j.websocket.extensions.compress.PerMessageDeflateExtension
-
Returns the name of the extension.
- getName() - Method in interface org.snf4j.websocket.extensions.IExtension
-
Returns the name of the extension.
- getNames() - Method in class org.snf4j.websocket.handshake.HandshakeFrame
-
Returns names of header fields already added to this frame.
- getOpcode() - Method in class org.snf4j.websocket.frame.Frame
-
Returns the type (opcode) of this frame.
- getOutboundType() - Method in class org.snf4j.websocket.frame.FrameAggregator
-
- getOutboundType() - Method in class org.snf4j.websocket.frame.FrameDecoder
-
- getOutboundType() - Method in class org.snf4j.websocket.frame.FrameEncoder
-
- getOutboundType() - Method in class org.snf4j.websocket.frame.FrameUtf8Validator
-
- getOutboundType() - Method in class org.snf4j.websocket.handshake.HandshakeDecoder
-
- getOutboundType() - Method in class org.snf4j.websocket.handshake.HandshakeEncoder
-
- getPayload() - Method in class org.snf4j.websocket.frame.AggregatedBinaryFrame
-
- getPayload() - Method in class org.snf4j.websocket.frame.AggregatedTextFrame
-
- getPayload() - Method in class org.snf4j.websocket.frame.Frame
-
Returns the payload data in this frame.
- getPayload() - Method in interface org.snf4j.websocket.frame.IAggregatedFrame
-
Returns the aggregated payload data from all payload data fragments already
stored in this frame.
- getPayloadLength() - Method in class org.snf4j.websocket.frame.AggregatedBinaryFrame
-
- getPayloadLength() - Method in class org.snf4j.websocket.frame.AggregatedTextFrame
-
- getPayloadLength() - Method in class org.snf4j.websocket.frame.Frame
-
Return the length of the payload data in this frame.
- getPayloadLength() - Method in interface org.snf4j.websocket.frame.IAggregatedFrame
-
Returns the total length of all payload data fragments already stored in this frame.
- getReadyFuture() - Method in class org.snf4j.websocket.SSLWebSocketSession
-
Gets the future that can be use to wait for the completion of the Web Socket
handshake phase.
- getReadyFuture() - Method in class org.snf4j.websocket.WebSocketSession
-
Gets the future that can be use to wait for the completion of the Web Socket
handshake phase.
- getReason() - Method in class org.snf4j.websocket.frame.CloseFrame
-
Returns the closing reason text in this frame.
- getReason() - Method in class org.snf4j.websocket.handshake.HandshakeResponse
-
Return the reason text of the HTTP response
- getRequestOrigin() - Method in class org.snf4j.websocket.DefaultWebSocketSessionConfig
-
Determines the value of the Origin header field in the client Web Socket
handshake request.
- getRequestOrigin() - Method in interface org.snf4j.websocket.IWebSocketSessionConfig
-
Determines the value of the Origin header field in the client Web Socket
handshake request.
- getRequestUri() - Method in class org.snf4j.websocket.DefaultWebSocketSessionConfig
-
- getRequestUri() - Method in interface org.snf4j.websocket.IWebSocketSessionConfig
-
Determines the request URI (the server endpoint) in the client Web Socket
handshake request.
- getRsvBits() - Method in class org.snf4j.websocket.frame.Frame
-
Returns the reserved bits for extensions or future versions.
- getStatus() - Method in class org.snf4j.websocket.frame.CloseFrame
-
Returns the closing status code in this frame.
- getStatus() - Method in class org.snf4j.websocket.handshake.HandshakeResponse
-
Return the status code of the HTTP response
- getSubProtocol() - Method in class org.snf4j.websocket.handshake.Handshaker
-
- getSubProtocol() - Method in interface org.snf4j.websocket.handshake.IHandshaker
-
Return the negotiated sub-protocol.
- getSupportedExtensions() - Method in class org.snf4j.websocket.DefaultWebSocketSessionConfig
-
Determines the supported extensions for both the server and client
Web Socket sessions.
- getSupportedExtensions() - Method in interface org.snf4j.websocket.IWebSocketSessionConfig
-
Determines the supported extensions for both the server and client
Web Socket sessions.
- getSupportedSubProtocols() - Method in class org.snf4j.websocket.DefaultWebSocketSessionConfig
-
Determines the names of supported subprotocols for both the server and client
Web Socket sessions.
- getSupportedSubProtocols() - Method in interface org.snf4j.websocket.IWebSocketSessionConfig
-
Determines the names of supported subprotocols for both the server and client
Web Socket sessions.
- getText() - Method in class org.snf4j.websocket.frame.ContinuationFrame
-
Returns the text data in this frame.
- getText() - Method in class org.snf4j.websocket.frame.TextFrame
-
Returns the text data in this frame.
- getUri() - Method in class org.snf4j.websocket.handshake.Handshaker
-
- getUri() - Method in class org.snf4j.websocket.handshake.HandshakeRequest
-
Returns the request URI of the GET method in the HTTP request frame.
- getUri() - Method in interface org.snf4j.websocket.handshake.IHandshaker
-
The URI identifying the Web Socket connection for both the client and
server sessions.
- getValue(String) - Method in class org.snf4j.websocket.handshake.HandshakeFrame
-
Returns the value of the header field identified by the specified name.
- getWebSocketHandler() - Method in interface org.snf4j.websocket.IWebSocketSession
-
Returns the Web Socket handler associated with this session
- getWebSocketHandler() - Method in class org.snf4j.websocket.SSLWebSocketSession
-
- getWebSocketHandler() - Method in class org.snf4j.websocket.WebSocketSession
-
- GOING_AWAY - Static variable in class org.snf4j.websocket.frame.CloseFrame
-
Indicates (value 1001) that an endpoint is "going away", such as a server
going down or a browser having navigated away from a page.
- GroupIdentifier - Enum in org.snf4j.websocket.extensions
-
An enum that represents predefined identifiers for extension groups.
- handleCloseFrame() - Method in class org.snf4j.websocket.DefaultWebSocketSessionConfig
-
Determines if the received Web Socket close frames should be handled
automatically.
- handleCloseFrame() - Method in interface org.snf4j.websocket.IWebSocketSessionConfig
-
Determines if the received Web Socket close frames should be handled
automatically.
- handshake() - Method in class org.snf4j.websocket.handshake.Handshaker
-
- handshake(HandshakeFrame) - Method in class org.snf4j.websocket.handshake.Handshaker
-
- handshake() - Method in interface org.snf4j.websocket.handshake.IHandshaker
-
Initiates the handshake phase by Web Socket clients.
- handshake(HandshakeFrame) - Method in interface org.snf4j.websocket.handshake.IHandshaker
-
Processes the handshake frame received from a Web Socket client.
- HANDSHAKE_DECODER - Static variable in interface org.snf4j.websocket.IWebSocketSessionConfig
-
The default key identifying the handshake decoder
HandshakeDecoder in
the default codec pipeline created by the SNF4J framework.
- HANDSHAKE_ENCODER - Static variable in interface org.snf4j.websocket.IWebSocketSessionConfig
-
The default key identifying the handshake encoder
HandshakeEncoder in
the default codec pipeline created by the SNF4J framework.
- HandshakeDecoder - Class in org.snf4j.websocket.handshake
-
Decodes a Web Socket handshake frame from bytes in the protocol version 13 format.
- HandshakeDecoder(boolean, int, int) - Constructor for class org.snf4j.websocket.handshake.HandshakeDecoder
-
Constructs a Web Socket handshake decoder.
- HandshakeDecoder(boolean, int) - Constructor for class org.snf4j.websocket.handshake.HandshakeDecoder
-
Constructs a Web Socket handshake decoder with the default maximum number
(50) of lines of a handshake frame to be decoded in a single pass.
- HandshakeDecoder(boolean) - Constructor for class org.snf4j.websocket.handshake.HandshakeDecoder
-
Constructs a Web Socket handshake decoder with the default maximum length
(65536) of a handshake frame and the default maximum number (50) of lines of
a handshake frame to be decoded in a single pass.
- HandshakeEncoder - Class in org.snf4j.websocket.handshake
-
Encodes a Web Socket handshake frame into bytes in the protocol version 13 format.
- HandshakeEncoder(boolean) - Constructor for class org.snf4j.websocket.handshake.HandshakeEncoder
-
Constructs a Web Socket handshake encoder.
- HandshakeFrame - Class in org.snf4j.websocket.handshake
-
Base class for Web Socket handshake frames.
- HandshakeFrame() - Constructor for class org.snf4j.websocket.handshake.HandshakeFrame
-
Construct a base Web Socket handshake frame.
- Handshaker - Class in org.snf4j.websocket.handshake
-
Default handshaker responsible for processing of the Web Socket handshake phase.
- Handshaker(IWebSocketSessionConfig, boolean) - Constructor for class org.snf4j.websocket.handshake.Handshaker
-
Constructs the handshaker.
- HandshakeRequest - Class in org.snf4j.websocket.handshake
-
A Web Socket handshake request frame.
- HandshakeRequest(String) - Constructor for class org.snf4j.websocket.handshake.HandshakeRequest
-
Constructs a Web Socket handshake request frame.
- HandshakeResponse - Class in org.snf4j.websocket.handshake
-
A Web Socket handshake response frame.
- HandshakeResponse(int, String) - Constructor for class org.snf4j.websocket.handshake.HandshakeResponse
-
Constructs a Web Socket handshake response frame.
- hasExtensions() - Method in class org.snf4j.websocket.handshake.Handshaker
-
- hasExtensions() - Method in interface org.snf4j.websocket.handshake.IHandshaker
-
Tells is any extension has been negotiated
- hasValue(String) - Method in class org.snf4j.websocket.handshake.HandshakeFrame
-
Checks if the header field identified by the specified name exists.
- IAggregatedFrame - Interface in org.snf4j.websocket.frame
-
An aggregated Web Socket frame.
- IExtension - Interface in org.snf4j.websocket.extensions
-
A Web Socket extension.
- ignoreHostHeaderField() - Method in class org.snf4j.websocket.DefaultWebSocketSessionConfig
-
Determines if the server session associated with this configuration object
should ignore missing the Host header field in the received Web Socket
handshake request.
- ignoreHostHeaderField() - Method in interface org.snf4j.websocket.IWebSocketSessionConfig
-
Determines if the server session associated with this configuration object
should ignore missing the Host header field in the received Web Socket
handshake request.
- IHandshaker - Interface in org.snf4j.websocket.handshake
-
A handshaker responsible for processing of the Web Socket handshake phase.
- InvalidExtensionException - Exception in org.snf4j.websocket.extensions
-
Indicates problems with decoding or validation of Web Socket extensions.
- InvalidExtensionException() - Constructor for exception org.snf4j.websocket.extensions.InvalidExtensionException
-
Constructs a new exception without the detail message.
- InvalidExtensionException(String) - Constructor for exception org.snf4j.websocket.extensions.InvalidExtensionException
-
Constructs a new exception with the specified detail message.
- InvalidExtensionException(String, Throwable) - Constructor for exception org.snf4j.websocket.extensions.InvalidExtensionException
-
Constructs a new exception with the specified detail message and cause.
- InvalidExtensionException(Throwable) - Constructor for exception org.snf4j.websocket.extensions.InvalidExtensionException
-
Constructs a new exception with the specified cause and a detail message
of (cause==null ? null : cause.toString()) (which typically
contains the class and detail message of cause).
- InvalidFrameException - Exception in org.snf4j.websocket.frame
-
Indicates problems with decoding or validation of Web Socket frames.
- InvalidFrameException(String, Throwable, boolean) - Constructor for exception org.snf4j.websocket.frame.InvalidFrameException
-
Constructs a new exception with the specified detail message, cause and
session closing type.
- InvalidFrameException(Throwable, boolean) - Constructor for exception org.snf4j.websocket.frame.InvalidFrameException
-
Constructs a new exception with the specified cause and session closing type.
- InvalidFrameException(String, Throwable) - Constructor for exception org.snf4j.websocket.frame.InvalidFrameException
-
Constructs a new exception with the specified detail message, cause and
with the gentle closing type.
- InvalidFrameException(String) - Constructor for exception org.snf4j.websocket.frame.InvalidFrameException
-
Constructs a new exception with the specified detail message and with the
gentle closing type.
- InvalidFrameException(Throwable) - Constructor for exception org.snf4j.websocket.frame.InvalidFrameException
-
Constructs a new exception with the specified cause and with the gentle
closing type.
- InvalidFrameException() - Constructor for exception org.snf4j.websocket.frame.InvalidFrameException
-
Constructs a new exception without the detail message and with the gentle
closing type.
- InvalidHandshakeException - Exception in org.snf4j.websocket.handshake
-
Indicates problems with decoding or validation of Web Socket handshake frames.
- InvalidHandshakeException(String, Throwable, boolean) - Constructor for exception org.snf4j.websocket.handshake.InvalidHandshakeException
-
Constructs a new exception with the specified detail message, cause and
session closing type.
- InvalidHandshakeException(Throwable, boolean) - Constructor for exception org.snf4j.websocket.handshake.InvalidHandshakeException
-
Constructs a new exception with the specified cause and session closing type.
- InvalidHandshakeException(String, Throwable) - Constructor for exception org.snf4j.websocket.handshake.InvalidHandshakeException
-
Constructs a new exception with the specified detail message, cause and
with the default closing type.
- InvalidHandshakeException(String) - Constructor for exception org.snf4j.websocket.handshake.InvalidHandshakeException
-
Constructs a new exception with the specified detail message and with the
default closing type.
- InvalidHandshakeException() - Constructor for exception org.snf4j.websocket.handshake.InvalidHandshakeException
-
Constructs a new exception without the detail message and with the default
closing type.
- InvalidHandshakeException(Throwable) - Constructor for exception org.snf4j.websocket.handshake.InvalidHandshakeException
-
Constructs a new exception with the specified cause and with the default
closing type.
- isClientMode() - Method in class org.snf4j.websocket.DefaultWebSocketSessionConfig
-
Tells if this configuration is for a client or server session.
- isClientMode() - Method in class org.snf4j.websocket.handshake.Handshaker
-
- isClientMode() - Method in interface org.snf4j.websocket.handshake.IHandshaker
-
Tells the mode (server/client) this handshaker is operating
- isClosing() - Method in class org.snf4j.websocket.handshake.Handshaker
-
- isClosing() - Method in interface org.snf4j.websocket.handshake.IHandshaker
-
Tells if this handshake is closing without successfully finishing the
handshake phase.
- isControl() - Method in enum org.snf4j.websocket.frame.Opcode
-
Tells if this Opcode is for a control frame.
- isFinalFragment() - Method in class org.snf4j.websocket.frame.Frame
-
Tells if this frame is the final fragment in a message.
- isFinished() - Method in class org.snf4j.websocket.handshake.Handshaker
-
- isFinished() - Method in interface org.snf4j.websocket.handshake.IHandshaker
-
Tells if this handshake has successfully finished the handshake phase.
- isRsvBit1() - Method in class org.snf4j.websocket.frame.Frame
-
Tells if the reserved bit 1 is set
- isRsvBit2() - Method in class org.snf4j.websocket.frame.Frame
-
Tells if the reserved bit 2 is set
- isRsvBit3() - Method in class org.snf4j.websocket.frame.Frame
-
Tells if the reserved bit 3 is set
- IWebSocketHandler - Interface in org.snf4j.websocket
-
Extends the
IStreamHandler interface to cover the Web Socket functionalities.
- IWebSocketSession - Interface in org.snf4j.websocket
-
Extends the
IStreamSession interface to cover the Web Socket functionalities.
- IWebSocketSessionConfig - Interface in org.snf4j.websocket
-
A configuration for associated Web Socket session.
- payload - Variable in class org.snf4j.websocket.frame.Frame
-
Payload data
- PERMESSAGE_DEFLATE_DECODER - Static variable in class org.snf4j.websocket.extensions.compress.PerMessageDeflateExtension
-
The default key identifying the pre-message deflate decoder
PerMessageDeflateDecoder in the default codec pipeline created by the
SNF4J framework.
- PERMESSAGE_DEFLATE_ENCODER - Static variable in class org.snf4j.websocket.extensions.compress.PerMessageDeflateExtension
-
The default key identifying the pre-message deflate encoder
PerMessageDeflateEncoder in the default codec pipeline created by the
SNF4J framework.
- PerMessageDeflateDecoder - Class in org.snf4j.websocket.extensions.compress
-
The per-message implementation of deflate decoder (decompressor).
- PerMessageDeflateDecoder(boolean, int) - Constructor for class org.snf4j.websocket.extensions.compress.PerMessageDeflateDecoder
-
Constructs a per-message deflate decoder with specified context takeover
control and minimum upper bound on the decompressed size.
- PerMessageDeflateDecoder(boolean) - Constructor for class org.snf4j.websocket.extensions.compress.PerMessageDeflateDecoder
-
Constructs a per-message deflate decoder with specified context takeover
control.
- PerMessageDeflateEncoder - Class in org.snf4j.websocket.extensions.compress
-
The per-message implementation of deflate encoder (compressor).
- PerMessageDeflateEncoder(int, boolean) - Constructor for class org.snf4j.websocket.extensions.compress.PerMessageDeflateEncoder
-
Constructs a per-message deflate encoder with specified compression level and
the context takeover control.
- PerMessageDeflateExtension - Class in org.snf4j.websocket.extensions.compress
-
The WebSocket Per-Message Compression Extension as described in RFC 7692
- PerMessageDeflateExtension(int, int, PerMessageDeflateExtension.NoContext, PerMessageDeflateExtension.NoContext) - Constructor for class org.snf4j.websocket.extensions.compress.PerMessageDeflateExtension
-
Constructs a pre-message deflate extension with specified compression level,
minimum upper bound on the decompressed size and the context takeover control
options for compression/decompression.
- PerMessageDeflateExtension(int, PerMessageDeflateExtension.NoContext, PerMessageDeflateExtension.NoContext) - Constructor for class org.snf4j.websocket.extensions.compress.PerMessageDeflateExtension
-
Constructs a pre-message deflate extension with specified compression level
and the context takeover control options for compression/decompression.
- PerMessageDeflateExtension(int) - Constructor for class org.snf4j.websocket.extensions.compress.PerMessageDeflateExtension
-
Constructs a pre-message deflate extension with specified compression level
and the
OPTIONAL context takeover control option for
compression/decompression.
- PerMessageDeflateExtension() - Constructor for class org.snf4j.websocket.extensions.compress.PerMessageDeflateExtension
-
Constructs a pre-message deflate extension with default compression level (6)
and the
OPTIONAL context takeover control option for
compression/decompression.
- PerMessageDeflateExtension.NoContext - Enum in org.snf4j.websocket.extensions.compress
-
The context takeover control options
- PingFrame - Class in org.snf4j.websocket.frame
-
Web Socket ping frame.
- PingFrame(int, byte[]) - Constructor for class org.snf4j.websocket.frame.PingFrame
-
Constructs a Web Socket ping frame.
- PingFrame(byte[]) - Constructor for class org.snf4j.websocket.frame.PingFrame
-
Constructs a Web Socket ping frame with all reserved bits cleared.
- PingFrame() - Constructor for class org.snf4j.websocket.frame.PingFrame
-
Constructs an empty Web Socket ping frame with all reserved bits cleared.
- POLICY_VALIDATION - Static variable in class org.snf4j.websocket.frame.CloseFrame
-
Indicates (value 1008) that an endpoint is terminating the connection because
it has received a message that violates its policy.
- PongFrame - Class in org.snf4j.websocket.frame
-
Web Socket pong frame.
- PongFrame(int, byte[]) - Constructor for class org.snf4j.websocket.frame.PongFrame
-
Constructs a Web Socket pong frame.
- PongFrame(byte[]) - Constructor for class org.snf4j.websocket.frame.PongFrame
-
Constructs a Web Socket pong frame with all reserved bits cleared.
- PongFrame() - Constructor for class org.snf4j.websocket.frame.PongFrame
-
Constructs an empty Web Socket pong frame with all reserved bits cleared.
- PROTOCOL_ERROR - Static variable in class org.snf4j.websocket.frame.CloseFrame
-
Indicates (value 1002) that an endpoint is terminating the connection due to
a protocol error.
- SERVICE_OVERLOAD - Static variable in class org.snf4j.websocket.frame.CloseFrame
-
Indicates (value 1013) that the service is experiencing overload.
- SERVICE_RESTART - Static variable in class org.snf4j.websocket.frame.CloseFrame
-
Indicates (value 1012) that the service is restarted.
- setHandleCloseFrame(boolean) - Method in class org.snf4j.websocket.DefaultWebSocketSessionConfig
-
Configures if the received Web Socket close frames should be handled
automatically.
- setIgnoreHostHeaderField(boolean) - Method in class org.snf4j.websocket.DefaultWebSocketSessionConfig
-
Configures if the server session associated with this configuration object
should ignore missing the Host header field in the received Web Socket
handshake request.
- setMaxFramePayloadLength(int) - Method in class org.snf4j.websocket.DefaultWebSocketSessionConfig
-
Sets the maximum length of the payload in the decoded Web Socket frames.
- setMaxHandshakeFrameLength(int) - Method in class org.snf4j.websocket.DefaultWebSocketSessionConfig
-
Sets the maximum length of the decoded Web Socket handshake frames.
- setRequestOrigin(String) - Method in class org.snf4j.websocket.DefaultWebSocketSessionConfig
-
Sets the value of the Origin header field in the client Web Socket handshake
request.
- setSession(ISession) - Method in class org.snf4j.websocket.handshake.Handshaker
-
- setSession(ISession) - Method in interface org.snf4j.websocket.handshake.IHandshaker
-
Sets the session object this handshaker is associated with.
- setSupportedExtensions(IExtension...) - Method in class org.snf4j.websocket.DefaultWebSocketSessionConfig
-
Sets the supported extensions for both the server and client
Web Socket sessions.
- setSupportedSubProtocols(String...) - Method in class org.snf4j.websocket.DefaultWebSocketSessionConfig
-
Sets the names of supported subprotocols for both the server and client
Web Socket sessions.
- SSLWebSocketSession - Class in org.snf4j.websocket
-
The Secure Web Socket session implementing the WebSocket Protocol described in RFC 6455.
- SSLWebSocketSession(String, SocketAddress, IWebSocketHandler, boolean) - Constructor for class org.snf4j.websocket.SSLWebSocketSession
-
Constructs a named Secure Web Socket session associated with a handler and a
remote peer.
- SSLWebSocketSession(SocketAddress, IWebSocketHandler, boolean) - Constructor for class org.snf4j.websocket.SSLWebSocketSession
-
Constructs a Secure Web Socket session associated with a handler and a
remote peer.
- SSLWebSocketSession(String, IWebSocketHandler, boolean) - Constructor for class org.snf4j.websocket.SSLWebSocketSession
-
Constructs a named Secure Web Socket session associated with a handler.
- SSLWebSocketSession(IWebSocketHandler, boolean) - Constructor for class org.snf4j.websocket.SSLWebSocketSession
-
Constructs a Secure Web Socket session associated with a handler.
- switchDecoders(ICodecPipeline, boolean) - Method in class org.snf4j.websocket.DefaultWebSocketSessionConfig
-
- switchDecoders(ICodecPipeline, boolean) - Method in interface org.snf4j.websocket.IWebSocketSessionConfig
-
Called when the decoders in the codec pipeline should be switched after
finishing of the Web Socket handshake.
- switchEncoders(ICodecPipeline, boolean) - Method in class org.snf4j.websocket.DefaultWebSocketSessionConfig
-
- switchEncoders(ICodecPipeline, boolean) - Method in interface org.snf4j.websocket.IWebSocketSessionConfig
-
Called when the encoders in the codec pipeline should be switched after
finishing of the Web Socket handshake.