org.atmosphere.vibe.platform.server

Interface ServerWebSocket

All Superinterfaces:

Wrapper

All Known Implementing Classes:

AbstractServerWebSocket, AtmosphereServerWebSocket, JwaServerWebSocket, PlayServerWebSocket, VertxServerWebSocket

public interface ServerWebSocket
extends Wrapper

Represents a server-side WebSocket session.

Implementations are not thread-safe and decide whether and which event is fired in asynchronous manner.

Author:

Donghwan Kim

See Also:

The WebSocket API by W3C, RFC6455 - The WebSocket Protocol

Method Summary

Methods

Modifier and Type	Method and Description
ServerWebSocket	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	messageAction(Action<Data> action) Attaches an action for the message event.
ServerWebSocket	send(ByteBuffer byteBuffer) Sends bytes message through the connection
ServerWebSocket	send(String data) Sends a text message through the connection.
String	uri() The URI used to connect.

Methods inherited from interface org.atmosphere.vibe.platform.Wrapper

unwrap

Method Detail

uri

String uri()

The URI used to connect.

close

ServerWebSocket close()

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

send

ServerWebSocket send(String data)

Sends a text message through the connection.

send

ServerWebSocket send(ByteBuffer byteBuffer)

Sends bytes message through the connection

Parameters:

byteBuffer -

messageAction

ServerWebSocket messageAction(Action<Data> action)

Attaches an action for the message event. The allowed message type is String for text messages. If the message is quite big, it may drain memory quickly.

errorAction

ServerWebSocket errorAction(Action<Throwable> action)

Attaches an action to handle error from various things. If an error occurs, the connection will be closed.

closeAction

ServerWebSocket closeAction(Action<Void> action)

Attaches an action for the close event. If the connection is already closed, the handler will be executed on addition. After close event, all the other event will be disabled.