Index

A B C D F G I M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

APPLICATION_MAX - Static variable in class io.helidon.websocket.WsCloseCodes

Application max value.

APPLICATION_MIN - Static variable in class io.helidon.websocket.WsCloseCodes

Application min value.

B

BAD_GATEWAY - Static variable in class io.helidon.websocket.WsCloseCodes

Server acting as gateway received an invalid response.

BINARY - Enum constant in enum class io.helidon.websocket.WsOpCode

Payload frame with binary payload.

C

CANNOT_ACCEPT - Static variable in class io.helidon.websocket.WsCloseCodes

Endpoint received an unsupported frame (e.g.

ClientWsFrame - Class in io.helidon.websocket

Frame from a client (always masked).

close(int, String) - Method in interface io.helidon.websocket.WsSession

Close session.

CLOSE - Enum constant in enum class io.helidon.websocket.WsOpCode

Close control frame.

closeCode() - Method in exception class io.helidon.websocket.WsCloseException

Close code that should be used to close the connection.

CLOSED_ABNORMALLY - Static variable in class io.helidon.websocket.WsCloseCodes

No close code frame has been received.

code() - Method in enum class io.helidon.websocket.WsOpCode

Numeric code (used in binary frame representation) of this operation code.

CONTINUATION - Enum constant in enum class io.helidon.websocket.WsOpCode

Continuation frame.

control(WsOpCode, BufferData) - Static method in class io.helidon.websocket.ClientWsFrame

Create a new control frame.

control(WsOpCode, BufferData) - Static method in class io.helidon.websocket.ServerWsFrame

Create a new control frame.

D

data(BufferData, boolean) - Static method in class io.helidon.websocket.ClientWsFrame

Create a binary data frame.

data(BufferData, boolean) - Static method in class io.helidon.websocket.ServerWsFrame

Create a binary data frame.

data(String, boolean) - Static method in class io.helidon.websocket.ClientWsFrame

Create a text data frame.

data(String, boolean) - Static method in class io.helidon.websocket.ServerWsFrame

Create a text data frame.

F

fin() - Method in class io.helidon.websocket.ClientWsFrame

fin() - Method in class io.helidon.websocket.ServerWsFrame

fin() - Method in interface io.helidon.websocket.WsFrame

Is the end of message (or end of continuation).

G

get(int) - Static method in enum class io.helidon.websocket.WsOpCode

Get operation code based on its numeric code.

GOING_AWAY - Static variable in class io.helidon.websocket.WsCloseCodes

Client is leaving (browser tab closing).

I

io.helidon.websocket - module io.helidon.websocket

Helidon WebSocket APIs.

io.helidon.websocket - package io.helidon.websocket

WebSocket APIs.

isPayload() - Method in class io.helidon.websocket.ClientWsFrame

isPayload() - Method in class io.helidon.websocket.ServerWsFrame

isPayload() - Method in interface io.helidon.websocket.WsFrame

Helper method to check whether this is a payload frame (text or binary), or a control frame (such as ping, pong, close etc.).

isPayload(AbstractWsFrame.FrameHeader) - Static method in class io.helidon.websocket.ClientWsFrame

isPayload(AbstractWsFrame.FrameHeader) - Static method in class io.helidon.websocket.ServerWsFrame

M

masked() - Method in class io.helidon.websocket.ClientWsFrame

masked() - Method in class io.helidon.websocket.ServerWsFrame

masked() - Method in interface io.helidon.websocket.WsFrame

Whether this frame is masked.

maskedData() - Method in class io.helidon.websocket.ClientWsFrame

Masked data of this frame, to be sent over the network.

maskingKey() - Method in class io.helidon.websocket.ClientWsFrame

maskingKey() - Method in class io.helidon.websocket.ServerWsFrame

maskingKey() - Method in interface io.helidon.websocket.WsFrame

Masking key, if WsFrame.masked() returns true.

N

NO_EXTENSION - Static variable in class io.helidon.websocket.WsCloseCodes

Client wanted an extension which server did not negotiate.

NO_STATUS_CODE - Static variable in class io.helidon.websocket.WsCloseCodes

Expected close status, received none.

NORMAL_CLOSE - Static variable in class io.helidon.websocket.WsCloseCodes

Code to use with WsSession.close(int, String) to indicate normal close operation.

NOT_CONSISTENT - Static variable in class io.helidon.websocket.WsCloseCodes

Endpoint received inconsistent message (e.g.

O

onClose(WsSession, int, String) - Method in interface io.helidon.websocket.WsListener

Received close.

onError(WsSession, Throwable) - Method in interface io.helidon.websocket.WsListener

Error occurred.

onHttpUpgrade(HttpPrologue, Headers) - Method in interface io.helidon.websocket.WsListener

Invoked during handshake process.

onMessage(WsSession, BufferData, boolean) - Method in interface io.helidon.websocket.WsListener

Received binary fragment.

onMessage(WsSession, String, boolean) - Method in interface io.helidon.websocket.WsListener

Received text fragment.

onOpen(WsSession) - Method in interface io.helidon.websocket.WsListener

Session is open.

onPing(WsSession, BufferData) - Method in interface io.helidon.websocket.WsListener

Received ping.

onPong(WsSession, BufferData) - Method in interface io.helidon.websocket.WsListener

Received pong.

opCode() - Method in class io.helidon.websocket.ClientWsFrame

opCode() - Method in class io.helidon.websocket.ServerWsFrame

opCode() - Method in interface io.helidon.websocket.WsFrame

Operation code of this frame.

opCode(WsOpCode) - Method in class io.helidon.websocket.ClientWsFrame

Configure the operation code of this frame.

opCode(WsOpCode) - Method in class io.helidon.websocket.ServerWsFrame

Configure the operation code of this frame.

P

payloadData() - Method in class io.helidon.websocket.ClientWsFrame

payloadData() - Method in class io.helidon.websocket.ServerWsFrame

payloadData() - Method in interface io.helidon.websocket.WsFrame

Always unmasked.

payloadLength() - Method in class io.helidon.websocket.ClientWsFrame

payloadLength() - Method in class io.helidon.websocket.ServerWsFrame

payloadLength() - Method in interface io.helidon.websocket.WsFrame

Length of the payload bytes.

ping(BufferData) - Method in interface io.helidon.websocket.WsSession

Send ping.

PING - Enum constant in enum class io.helidon.websocket.WsOpCode

Ping control frame.

pong(BufferData) - Method in interface io.helidon.websocket.WsSession

Send pong.

PONG - Enum constant in enum class io.helidon.websocket.WsOpCode

Pong control frame.

PROTOCOL_ERROR - Static variable in class io.helidon.websocket.WsCloseCodes

Endpoint received a malformed frame.

R

read(SocketContext, DataReader, int) - Static method in class io.helidon.websocket.ClientWsFrame

Read client frame from request data.

read(SocketContext, DataReader, int) - Static method in class io.helidon.websocket.ServerWsFrame

Read server frame from request data.

readFrameHeader(DataReader, int) - Static method in class io.helidon.websocket.ClientWsFrame

readFrameHeader(DataReader, int) - Static method in class io.helidon.websocket.ServerWsFrame

readPayload(DataReader, AbstractWsFrame.FrameHeader) - Static method in class io.helidon.websocket.ClientWsFrame

readPayload(DataReader, AbstractWsFrame.FrameHeader) - Static method in class io.helidon.websocket.ServerWsFrame

REGISTERED_AT_IANA_MAX - Static variable in class io.helidon.websocket.WsCloseCodes

Registered at IANA max value.

REGISTERED_AT_IANA_MIN - Static variable in class io.helidon.websocket.WsCloseCodes

Registered at IANA min value.

RESERVED_FOR_EXTENSIONS_MAX - Static variable in class io.helidon.websocket.WsCloseCodes

Reserved for extensions max value.

RESERVED_FOR_EXTENSIONS_MIN - Static variable in class io.helidon.websocket.WsCloseCodes

Reserved for extensions min value.

RESERVED_FOR_LATER_MAX - Static variable in class io.helidon.websocket.WsCloseCodes

Reserved for later max value.

RESERVED_FOR_LATER_MIN - Static variable in class io.helidon.websocket.WsCloseCodes

Reserved for later min value.

S

send(BufferData, boolean) - Method in interface io.helidon.websocket.WsSession

Send binary fragment.

send(String, boolean) - Method in interface io.helidon.websocket.WsSession

Send text fragment.

ServerWsFrame - Class in io.helidon.websocket

Frame from a server (never masked).

SERVICE_RESTART - Static variable in class io.helidon.websocket.WsCloseCodes

Server/service is restarting.

subProtocol() - Method in interface io.helidon.websocket.WsSession

The WebSocket sub-protocol negotiated for this session.

T

terminate() - Method in interface io.helidon.websocket.WsSession

Terminate session.

TEXT - Enum constant in enum class io.helidon.websocket.WsOpCode

Payload frame with text payload.

TLS_HANDSHAKE_FAIL - Static variable in class io.helidon.websocket.WsCloseCodes

Transport Layer Security handshake failure.

TOO_BIG - Static variable in class io.helidon.websocket.WsCloseCodes

Endpoint won't process large frame.

toString() - Method in class io.helidon.websocket.ClientWsFrame

toString() - Method in class io.helidon.websocket.ServerWsFrame

TRY_AGAIN_LATER - Static variable in class io.helidon.websocket.WsCloseCodes

Temporary server condition forced blocking client's request.

U

UNEXPECTED_CONDITION - Static variable in class io.helidon.websocket.WsCloseCodes

Internal server error while operating.

V

valueOf(String) - Static method in enum class io.helidon.websocket.WsOpCode

Returns the enum constant of this class with the specified name.

values() - Static method in enum class io.helidon.websocket.WsOpCode

Returns an array containing the constants of this enum class, in the order they are declared.

VIOLATED_POLICY - Static variable in class io.helidon.websocket.WsCloseCodes

Generic code used for situations other than 1003 and 1009.

W

WsCloseCodes - Class in io.helidon.websocket

Codes to use with WsSession.close(int, String) and to receive in WsListener.onClose(WsSession, int, String).

WsCloseException - Exception Class in io.helidon.websocket

Exception requesting a close of the WebSocket communication.

WsCloseException(String, int) - Constructor for exception class io.helidon.websocket.WsCloseException

Create a new exception.

WsFrame - Interface in io.helidon.websocket

WebSocket frame.

WsListener - Interface in io.helidon.websocket

WebSocket listener.

WsOpCode - Enum Class in io.helidon.websocket

WebSocket operation code.

WsSession - Interface in io.helidon.websocket

WebSocket session.

WsUpgradeException - Exception Class in io.helidon.websocket

An exception that may be thrown by WsListener.onHttpUpgrade(HttpPrologue, io.helidon.http.Headers) during handshake process to reject a websocket upgrade.

WsUpgradeException(String) - Constructor for exception class io.helidon.websocket.WsUpgradeException

Create exception from message.

WsUpgradeException(String, Throwable) - Constructor for exception class io.helidon.websocket.WsUpgradeException

Create exception from message and cause.

A B C D F G I M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form