Package com.corundumstudio.socketio.transport

Class NamespaceClient

java.lang.Object

com.corundumstudio.socketio.transport.NamespaceClient

All Implemented Interfaces:

ClientOperations, SocketIOClient, Store

public class NamespaceClient
extends Object
implements SocketIOClient

Constructor Summary

Constructors

Constructor	Description
NamespaceClient(ClientHead baseClient, Namespace namespace)

Method Summary

Modifier and Type	Method	Description
void	del(String key)
void	disconnect()	Disconnect client
boolean	equals(Object obj)
<T> T	get(String key)
Set<String>	getAllRooms()	Get all rooms a client is joined in.
ClientHead	getBaseClient()
int	getCurrentRoomSize(String room)	Get current room Size (contain in cluster)
EngineIOVersion	getEngineIOVersion()	Engine IO Protocol version
HandshakeData	getHandshakeData()	Handshake data used during client connection
Namespace	getNamespace()	Client namespace
SocketAddress	getRemoteAddress()	Get client remote address
UUID	getSessionId()	Client session id, uses UUID object
Transport	getTransport()	Current client transport protocol
boolean	has(String key)
int	hashCode()
boolean	isChannelOpen()	Check is underlying channel open
boolean	isWritable()	Returns true if and only if the I/O thread will perform the requested write operation immediately.
void	joinRoom(String room)	Join client to room
void	joinRooms(Set<String> rooms)	Join client to rooms
void	leaveRoom(String room)	Leave client from room
void	leaveRooms(Set<String> rooms)	Leave client from rooms
void	onDisconnect()
void	send(Packet packet)	Send custom packet.
void	send(Packet packet, AckCallback<?> ackCallback)	Send packet with ack callback
void	sendEvent(String name, AckCallback<?> ackCallback, Object... data)	Send event with ack callback
void	sendEvent(String name, Object... data)	Send event
void	set(String key, Object val)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

NamespaceClient

public NamespaceClient(ClientHead baseClient,
 Namespace namespace)

Method Details

getBaseClient

public ClientHead getBaseClient()

getTransport

public Transport getTransport()

Description copied from interface: SocketIOClient

Current client transport protocol

Specified by:

getTransport in interface SocketIOClient

Returns:

transport protocol

getEngineIOVersion

public EngineIOVersion getEngineIOVersion()

Description copied from interface: SocketIOClient

Engine IO Protocol version

Specified by:

getEngineIOVersion in interface SocketIOClient

Returns:

isChannelOpen

public boolean isChannelOpen()

Description copied from interface: SocketIOClient

Check is underlying channel open

Specified by:

isChannelOpen in interface SocketIOClient

Returns:

true if channel open, otherwise false

getNamespace

public Namespace getNamespace()

Description copied from interface: SocketIOClient

Client namespace

Specified by:

getNamespace in interface SocketIOClient

Returns:

- namespace

sendEvent

public void sendEvent(String name,
 Object... data)

Description copied from interface: ClientOperations

Send event

Specified by:

sendEvent in interface ClientOperations

Parameters:

name - - event name

data - - event data

sendEvent

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

Description copied from interface: SocketIOClient

Send event with ack callback

Specified by:

sendEvent in interface SocketIOClient

Parameters:

name - - event name

ackCallback - - ack callback

data - - event data

isWritable

public boolean isWritable()

Description copied from interface: SocketIOClient

Returns true if and only if the I/O thread will perform the requested write operation immediately. Any write requests made when this method returns false are queued until the I/O thread is ready to process the queued write requests.

Specified by:

isWritable in interface SocketIOClient

Returns:

send

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

Description copied from interface: SocketIOClient

Send packet with ack callback

Specified by:

send in interface SocketIOClient

Parameters:

packet - - packet to send

ackCallback - - ack callback

send

public void send(Packet packet)

Description copied from interface: ClientOperations

Send custom packet. But ClientOperations.sendEvent(java.lang.String, java.lang.Object...) method usage is enough for most cases.

Specified by:

send in interface ClientOperations

Parameters:

packet - - packet to send

onDisconnect

public void onDisconnect()

disconnect

public void disconnect()

Description copied from interface: ClientOperations

Disconnect client

Specified by:

disconnect in interface ClientOperations

getSessionId

public UUID getSessionId()

Description copied from interface: SocketIOClient

Client session id, uses UUID object

Specified by:

getSessionId in interface SocketIOClient

Returns:

- session id

getRemoteAddress

public SocketAddress getRemoteAddress()

Description copied from interface: SocketIOClient

Get client remote address

Specified by:

getRemoteAddress in interface SocketIOClient

Returns:

remote address

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

joinRoom

public void joinRoom(String room)

Description copied from interface: SocketIOClient

Join client to room

Specified by:

joinRoom in interface SocketIOClient

Parameters:

room - - name of room

joinRooms

public void joinRooms(Set<String> rooms)

Description copied from interface: SocketIOClient

Join client to rooms

Specified by:

joinRooms in interface SocketIOClient

Parameters:

rooms - - names of rooms

leaveRoom

public void leaveRoom(String room)

Description copied from interface: SocketIOClient

Leave client from room

Specified by:

leaveRoom in interface SocketIOClient

Parameters:

room - - name of room

leaveRooms

public void leaveRooms(Set<String> rooms)

Description copied from interface: SocketIOClient

Leave client from rooms

Specified by:

leaveRooms in interface SocketIOClient

Parameters:

rooms - - names of rooms

set

public void set(String key,
 Object val)

Specified by:

set in interface Store

get

public <T> T get(String key)

Specified by:

get in interface Store

has

public boolean has(String key)

Specified by:

has in interface Store

del

public void del(String key)

Specified by:

del in interface Store

getAllRooms

public Set<String> getAllRooms()

Description copied from interface: SocketIOClient

Get all rooms a client is joined in.

Specified by:

getAllRooms in interface SocketIOClient

Returns:

name of rooms

getCurrentRoomSize

public int getCurrentRoomSize(String room)

Description copied from interface: SocketIOClient

Get current room Size (contain in cluster)

Specified by:

getCurrentRoomSize in interface SocketIOClient

Parameters:

room - - name of room

Returns:

int

getHandshakeData

public HandshakeData getHandshakeData()

Description copied from interface: SocketIOClient

Handshake data used during client connection

Specified by:

getHandshakeData in interface SocketIOClient

Returns:

HandshakeData