org.atmosphere.vibe.platform.ws

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

Methods

Modifier and Type	Method and Description
ServerWebSocket	binaryAction(Action<ByteBuffer> action) Attaches an action for the binary frame.
void	close() Closes the connection.
ServerWebSocket	closeAction(Action<Void> action) Attaches an action for the close event.
ServerWebSocket	errorAction(Action<Throwable> action) Attaches an action to handle error from various things.
ServerWebSocket	send(ByteBuffer byteBuffer) Sends a binary frame through the connection.
ServerWebSocket	send(String data) Sends a text frame through the connection.
ServerWebSocket	textAction(Action<String> action) Attaches an action for the text frame.
<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.

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.

textAction

ServerWebSocket textAction(Action<String> action)

Attaches an action for the text frame.

binaryAction

ServerWebSocket binaryAction(Action<ByteBuffer> action)

Attaches an action for the binary frame.

closeAction

ServerWebSocket closeAction(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.

errorAction

ServerWebSocket errorAction(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.