io.cettia.asity.websocket

Interface ServerWebSocket

All Known Implementing Classes:

AbstractServerWebSocket

public interface ServerWebSocket

Represents a server-side WebSocket.

Implementations are not thread-safe.

Author:

Donghwan Kim

See Also:

RFC6455 - The WebSocket Protocol

Method Summary

Modifier and Type	Method and Description
void	close() Closes the connection.
String	header(String name) Returns the first handshake request header associated with the given name.
Set<String>	headerNames() The names of the handshake request headers.
List<String>	headers(String name) Returns the handshake request headers associated with the given name or empty list if no header is found.
ServerWebSocket	onbinary(Action<ByteBuffer> action) Attaches an action for the binary frame.
ServerWebSocket	onclose(Action<Void> action) Attaches an action for the close event.
ServerWebSocket	onerror(Action<Throwable> action) Attaches an action to handle error from various things.
ServerWebSocket	ontext(Action<String> action) Attaches an action for the text frame.
ServerWebSocket	send(ByteBuffer byteBuffer) Sends a binary frame through the connection.
ServerWebSocket	send(String data) Sends a text frame through the connection.
<T> T	unwrap(Class<T> clazz) Returns the provider-specific component.
String	uri() The URI used to connect.

Method Detail

uri

String uri()

The URI used to connect.

headerNames

Set<String> headerNames()

The names of the handshake request headers. HTTP header is not case-sensitive but Set is case-sensitive.

header

String header(String name)

Returns the first handshake request header associated with the given name.

headers

List<String> headers(String name)

Returns the handshake request headers associated with the given name or empty list if no header is found.

close

void close()

Closes the connection. This method has no side effect if called more than once.

send

ServerWebSocket send(String data)

Sends a text frame through the connection.

send

ServerWebSocket send(ByteBuffer byteBuffer)

Sends a binary frame through the connection.

ontext

ServerWebSocket ontext(Action<String> action)

Attaches an action for the text frame.

onbinary

ServerWebSocket onbinary(Action<ByteBuffer> action)

Attaches an action for the binary frame.

onclose

ServerWebSocket onclose(Action<Void> action)

Attaches an action for the close event. After this event, the instance shouldn't be used and all the other events will be disabled.

onerror

ServerWebSocket onerror(Action<Throwable> action)

Attaches an action to handle error from various things. Its exact behavior is platform-specific and error created by the platform is propagated.

unwrap

<T> T unwrap(Class<T> clazz)

Returns the provider-specific component.