act.xio

Interface WebSocketConnection

All Superinterfaces:

Destroyable

All Known Implementing Classes:

UndertowWebSocketConnection, WebSocketContext

public interface WebSocketConnection
extends Destroyable

A WebSocket connection

Nested Class Summary

Nested classes/interfaces inherited from interface act.Destroyable

Destroyable.Util

Method Summary

Modifier and Type	Method and Description
void	close() Close the connection.
boolean	closed() Check if the connection has been closed
void	send(String message) Send a text message through websocket
String	sessionId() Session ID of this connection
String	username() Returns the username which is gained when connection is setup by calling H.KV.get(String) with AppConfig.sessionKeyUsername()

Methods inherited from interface act.Destroyable

destroy, isDestroyed, scope

Method Detail

sessionId

String sessionId()

Session ID of this connection

Returns:

connection session id

username

String username()

Returns the username which is gained when connection is setup by calling H.KV.get(String) with AppConfig.sessionKeyUsername()

Returns:

the username or null if there is no logged in user when connection is setup

send

void send(String message)

Send a text message through websocket

Parameters:

message - the text message

close

void close()

Close the connection. Note if there are any IOException raised by the underline network layer, it will be ignored

closed

boolean closed()

Check if the connection has been closed

Returns:

true if connection is closed