Package com.adobe.granite.socketio

Interface SocketIOSocket

All Superinterfaces:

SocketIOEmitter

@ProviderType
public interface SocketIOSocket
extends SocketIOEmitter

A Socket is the fundamental class for interacting with browser clients. A Socket belongs to a certain Namespace (by default /) and uses an underlying Client to communicate.

Method Summary

Modifier and Type	Method	Description
SocketIOEmitter	broadcast()	Sets a modifier for a subsequent event emission that the event will sent to all sockets except to itself.
SocketIOSocket	disconnect(boolean close)	Disconnects this socket.
SocketIOSocket	emit(String eventName, SocketIOAckListener ackListener, Object... arguments)	Emits an event to the socket identified by the string name.
SocketIOSocket	emit(String eventName, SocketIOAckListener ackListener, JSONArray arguments)	Emits an event to the socket identified by the string name.
String	getId()	A unique identifier for the socket session, that comes from the underlying Client.
SocketIONamespace	getNamespace()	Client namespace
Set<String>	getRooms()	A list of strings identifying the rooms this socket is in.
Principal	getUserPrincipal()
SocketIOSocket	join(String name)	Adds the socket to the room, and fires optionally a callback fn with err signature (if any).
SocketIOSocket	leave(String name)	Removes the socket from room, and fires optionally a callback fn with err signature (if any).
SocketIOSocket	removeListener(SocketIOSocketListener listener)	Removes a listener from this socket.
SocketIOSocket	setListener(SocketIOSocketListener listener)	Sets a listener to this socket that will receive the socket events.

Methods inherited from interface com.adobe.granite.socketio.SocketIOEmitter

emit, emit, to

Method Detail

setListener

@Nonnull
SocketIOSocket setListener(@Nonnull
                           SocketIOSocketListener listener)

Sets a listener to this socket that will receive the socket events.

Parameters:

listener - the listener

Returns:

this

Throws:

IllegalArgumentException - if this socket already has a listener

removeListener

@Nonnull
SocketIOSocket removeListener(@Nonnull
                              SocketIOSocketListener listener)

Removes a listener from this socket. If this socket has no listener defined, this method has no effect.

Parameters:

listener - the listener

Returns:

this

Throws:

IllegalArgumentException - if this socket already has a listener defined that is not the given one.

getId

@Nonnull
String getId()

A unique identifier for the socket session, that comes from the underlying Client.

Returns:

the id

getNamespace

@Nonnull
SocketIONamespace getNamespace()

Client namespace

Returns:

- namespace

getRooms

@Nonnull
Set<String> getRooms()

A list of strings identifying the rooms this socket is in.

Returns:

set of rooms

disconnect

@Nonnull
SocketIOSocket disconnect(boolean close)

Disconnects this socket.

Parameters:

close - true to also close the underlying connection

Returns:

this

join

@Nonnull
SocketIOSocket join(@Nonnull
                    String name)

Adds the socket to the room, and fires optionally a callback fn with err signature (if any). The socket is automatically a member of a room identified with its session id (see Socket#id). The mechanics of joining rooms are handled by the Adapter that has been configured (see Server#adapter above), defaulting to socket.io-adapter.

Parameters:

name - room name

Returns:

this

leave

@Nonnull
SocketIOSocket leave(@Nonnull
                     String name)

Removes the socket from room, and fires optionally a callback fn with err signature (if any). Rooms are left automatically upon disconnection. The mechanics of leaving rooms are handled by the Adapter that has been configured (see Server#adapter above), defaulting to socket.io-adapter.

Parameters:

name - room name

Returns:

this

broadcast

@Nonnull
SocketIOEmitter broadcast()

Sets a modifier for a subsequent event emission that the event will sent to all sockets except to itself.

Returns:

an emitter

emit

@Nonnull
SocketIOSocket emit(@Nonnull
                    String eventName,
                    @Nonnull
                    SocketIOAckListener ackListener,
                    @Nonnull
                    Object... arguments)
             throws IOException

Emits an event to the socket identified by the string name. Any other parameters can be included. The called needs to specify an SocketIOAckListener that will be called after the client sent the ack response.

Parameters:

eventName - name of the event

ackListener - the acknowledge listener

arguments - optional arguments

Returns:

this

Throws:

IOException - error

emit

@Nonnull
SocketIOSocket emit(@Nonnull
                    String eventName,
                    @Nonnull
                    SocketIOAckListener ackListener,
                    @Nonnull
                    JSONArray arguments)
             throws IOException

Emits an event to the socket identified by the string name. Any other parameters can be included. The called needs to specify an SocketIOAckListener that will be called after the client sent the ack response.

Parameters:

eventName - name of the event

ackListener - the acknowledge listener

arguments - optional arguments

Returns:

this

Throws:

IOException - error

getUserPrincipal

Principal getUserPrincipal()

Returns:

the Principal of the current authenticated user.