Package com.corundumstudio.socketio

Interface SocketIOClient

All Superinterfaces:

ClientOperations, Store

All Known Implementing Classes:

NamespaceClient

public interface SocketIOClient
extends ClientOperations, Store

Fully thread-safe.

Method Summary

Modifier and Type	Method	Description
Set<String>	getAllRooms()	Get all rooms a client is joined in.
int	getCurrentRoomSize(String room)	Get current room Size (contain in cluster)
HandshakeData	getHandshakeData()	Handshake data used during client connection
SocketIONamespace	getNamespace()	Client namespace
SocketAddress	getRemoteAddress()	Get client remote address
UUID	getSessionId()	Client session id, uses UUID object
Transport	getTransport()	Current client transport protocol
boolean	isChannelOpen()	Check is underlying channel open
void	joinRoom(String room)	Join client to room
void	leaveRoom(String room)	Join client to room
void	send(Packet packet, AckCallback<?> ackCallback)	Send packet with ack callback
void	sendEvent(String name, AckCallback<?> ackCallback, Object... data)	Send event with ack callback

Methods inherited from interface com.corundumstudio.socketio.ClientOperations

disconnect, send, sendEvent

Methods inherited from interface com.corundumstudio.socketio.store.Store

del, get, has, set

Method Details

getHandshakeData

HandshakeData getHandshakeData()

Handshake data used during client connection

Returns:

HandshakeData

getTransport

Transport getTransport()

Current client transport protocol

Returns:

transport protocol

sendEvent

void sendEvent(String name,
 AckCallback<?> ackCallback,
 Object... data)

Send event with ack callback

Parameters:

name - - event name

data - - event data

ackCallback - - ack callback

send

void send(Packet packet,
 AckCallback<?> ackCallback)

Send packet with ack callback

Parameters:

packet - - packet to send

ackCallback - - ack callback

getNamespace

SocketIONamespace getNamespace()

Client namespace

Returns:

- namespace

getSessionId

UUID getSessionId()

Client session id, uses UUID object

Returns:

- session id

getRemoteAddress

SocketAddress getRemoteAddress()

Get client remote address

Returns:

remote address

isChannelOpen

boolean isChannelOpen()

Check is underlying channel open

Returns:

true if channel open, otherwise false

joinRoom

void joinRoom(String room)

Join client to room

Parameters:

room - - name of room

leaveRoom

void leaveRoom(String room)

Join client to room

Parameters:

room - - name of room

getAllRooms

Set<String> getAllRooms()

Get all rooms a client is joined in.

Returns:

name of rooms

getCurrentRoomSize

int getCurrentRoomSize(String room)

Get current room Size (contain in cluster)

Parameters:

room - - name of room

Returns:

int