io.socket.client

Class Socket

java.lang.Object

io.socket.emitter.Emitter

io.socket.client.Socket

public class Socket
extends io.socket.emitter.Emitter

The socket class for Socket.IO Client.

Nested Class Summary

Nested classes/interfaces inherited from class io.socket.emitter.Emitter

io.socket.emitter.Emitter.Listener

Field Summary

Fields

Modifier and Type	Field and Description
static String	EVENT_CONNECT Called on a connection.
static String	EVENT_CONNECT_ERROR Called on a connection error.
static String	EVENT_DISCONNECT Called on a disconnection.
protected static Map<String,Integer>	RESERVED_EVENTS

Constructor Summary

Constructors

Constructor and Description
Socket(Manager io, String nsp, Manager.Options opts)

Method Summary

Modifier and Type	Method and Description
Socket	close() Disconnects the socket.
Socket	connect() Connects the socket.
boolean	connected()
Socket	disconnect() Disconnects the socket.
io.socket.emitter.Emitter	emit(String event, Object... args) Emits an event.
io.socket.emitter.Emitter	emit(String event, Object[] args, Ack ack) Emits an event with an acknowledge.
String	id() A property on the socket instance that is equal to the underlying engine.io socket id.
Manager	io()
boolean	isActive()
Socket	open() Connects the socket.
Socket	send(Object... args) Send messages.

Methods inherited from class io.socket.emitter.Emitter

hasListeners, listeners, off, off, off, on, once

Methods inherited from class java.lang.Object

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

Field Detail

EVENT_CONNECT

public static final String EVENT_CONNECT

Called on a connection.

See Also:

Constant Field Values

EVENT_DISCONNECT

public static final String EVENT_DISCONNECT

Called on a disconnection.

See Also:

Constant Field Values

EVENT_CONNECT_ERROR

public static final String EVENT_CONNECT_ERROR

Called on a connection error.

Parameters:

• (Exception) error data.

See Also:

Constant Field Values

RESERVED_EVENTS

protected static Map<String,Integer> RESERVED_EVENTS

Constructor Detail

Socket

public Socket(Manager io,
              String nsp,
              Manager.Options opts)

Method Detail

isActive

public boolean isActive()

open

public Socket open()

Connects the socket.

connect

public Socket connect()

Connects the socket.

send

public Socket send(Object... args)

Send messages.

Parameters:

args - data to send.

Returns:

a reference to this object.

emit

public io.socket.emitter.Emitter emit(String event,
                                      Object... args)

Emits an event. When you pass Ack at the last argument, then the acknowledge is done.

Overrides:

emit in class io.socket.emitter.Emitter

Parameters:

event - an event name.

args - data to send.

Returns:

a reference to this object.

emit

public io.socket.emitter.Emitter emit(String event,
                                      Object[] args,
                                      Ack ack)

Emits an event with an acknowledge.

Parameters:

event - an event name

args - data to send.

ack - the acknowledgement to be called

Returns:

a reference to this object.

close

public Socket close()

Disconnects the socket.

Returns:

a reference to this object.

disconnect

public Socket disconnect()

Disconnects the socket.

Returns:

a reference to this object.

io

public Manager io()

connected

public boolean connected()

id

public String id()

A property on the socket instance that is equal to the underlying engine.io socket id. The value is present once the socket has connected, is removed when the socket disconnects and is updated if the socket reconnects.

Returns:

a socket id