org.everrest.websockets

Interface WSConnection

All Known Implementing Classes:

WSConnectionImpl

public interface WSConnection

Web socket connection abstraction.

Author:

andrew00x

Method Summary

Modifier and Type	Method and Description
void	close() Close this connection with 1000 status which indicates a normal closure.
void	close(int status, String message) Close this connection with specified status and message.
Object	getAttribute(String name) Returns the object bound with the specified name in this connection, or null if no object is bound under the name.
Collection<String>	getChannels() Get optional set of channels assigned for this connection.
int	getCloseStatus() Get connection close status.
javax.servlet.http.HttpSession	getHttpSession() Get HTTP session associated to this connection.
Long	getId() Get unique connection identifier.
javax.websocket.Session	getWsSession()
boolean	isConnected() Check connection state.
void	registerMessageReceiver(WSMessageReceiver messageReceiver) Register new WSMessageReceiver for this connection.
void	removeAttribute(String name) Removes the object bound with the specified name from this connection.
void	removeMessageReceiver(WSMessageReceiver messageReceiver) Unregister WSMessageReceiver.
void	sendMessage(OutputMessage output) Send message to client.
void	setAttribute(String name, Object value) Binds an object to this connection, using the name specified.
boolean	subscribeToChannel(String channel) Subscribe this connection to specified channel.
boolean	unsubscribeFromChannel(String channel) Unsubscribe this connection from specified channel.

Method Detail

getId

Long getId()

Get unique connection identifier.

Returns:

unique connection identifier

getHttpSession

javax.servlet.http.HttpSession getHttpSession()

Get HTTP session associated to this connection.

Returns:

HTTP session associated to this connection

getWsSession

javax.websocket.Session getWsSession()

subscribeToChannel

boolean subscribeToChannel(String channel)

Subscribe this connection to specified channel.

Parameters:

channel - channel name

Returns:

true if this connection is subscribed to channel successfully and false if connection already subscribed to specified channel

See Also:

WSConnectionContext.sendMessage(org.everrest.websockets.message.ChannelBroadcastMessage)

unsubscribeFromChannel

boolean unsubscribeFromChannel(String channel)

Unsubscribe this connection from specified channel.

Parameters:

channel - channel name

Returns:

true if this connection is unsubscribed from channel successfully and false if connection is not subscribed to specified channel

See Also:

WSConnectionContext.sendMessage(org.everrest.websockets.message.ChannelBroadcastMessage)

getChannels

Collection<String> getChannels()

Get optional set of channels assigned for this connection. Channel may be used for sending the same message to more than one connection at one time.

Returns:

unmodifiable set of channel names this connection subscribed

See Also:

WSConnectionContext.sendMessage(org.everrest.websockets.message.ChannelBroadcastMessage)

isConnected

boolean isConnected()

Check connection state.

Returns:

true if connection is alive and false if connection already closed.

getCloseStatus

int getCloseStatus()

Get connection close status. If connection is alive or not opened yet this method return 0.

Returns:

connection close status or 0 if connection is alive or not opened yet

close

void close()
    throws IOException

Close this connection with 1000 status which indicates a normal closure.

Throws:

IOException - if any i/o error occurs

close

void close(int status,
           String message)
    throws IOException

Close this connection with specified status and message.

Parameters:

status - connection close status

message - optional message

Throws:

IOException - if any i/o error occurs

sendMessage

void sendMessage(OutputMessage output)
          throws javax.websocket.EncodeException,
                 IOException

Send message to client.

Parameters:

output - output message

Throws:

javax.websocket.EncodeException - if message cannot be serialized

IOException - if any i/o error occurs when try to send message to client

registerMessageReceiver

void registerMessageReceiver(WSMessageReceiver messageReceiver)

Register new WSMessageReceiver for this connection.

Parameters:

messageReceiver - message receiver

removeMessageReceiver

void removeMessageReceiver(WSMessageReceiver messageReceiver)

Unregister WSMessageReceiver.

Parameters:

messageReceiver - message receiver

getAttribute

Object getAttribute(String name)

Returns the object bound with the specified name in this connection, or null if no object is bound under the name.

Parameters:

name - a string specifying the name of the object

Returns:

the object with the specified name

setAttribute

void setAttribute(String name,
                  Object value)

Binds an object to this connection, using the name specified. If an object of the same name is already bound to the connection, the object is replaced.

Parameters:

name - the name to which the object is bound; cannot be null

value - the object to be bound

removeAttribute

void removeAttribute(String name)

Removes the object bound with the specified name from this connection. If the connection does not have an object bound with the specified name, this method does nothing.

Parameters:

name - the name of the object to remove from this connection