Socket (socket.io-client 1.0.0 API)

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`
`static String`	`EVENT_CONNECT_TIMEOUT`
`static String`	`EVENT_CONNECTING`
`static String`	`EVENT_DISCONNECT` Called on a disconnection.
`static String`	`EVENT_ERROR` Called on a connection error.
`static String`	`EVENT_MESSAGE`
`static String`	`EVENT_PING`
`static String`	`EVENT_PONG`
`static String`	`EVENT_RECONNECT`
`static String`	`EVENT_RECONNECT_ATTEMPT`
`static String`	`EVENT_RECONNECT_ERROR`
`static String`	`EVENT_RECONNECT_FAILED`
`static String`	`EVENT_RECONNECTING`
`protected static Map<String,Integer>`	`events`

Constructor Summary

Constructors
Constructor and Description

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

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

Method Summary

All Methods Instance Methods Concrete Methods
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()`
`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_CONNECTING
```
public static final String EVENT_CONNECTING
```
    See Also:
    
    Constant Field Values
  - EVENT_DISCONNECT
```
public static final String EVENT_DISCONNECT
```
    Called on a disconnection.
    
    See Also:
    
    Constant Field Values
  - EVENT_ERROR
```
public static final String EVENT_ERROR
```
    Called on a connection error.
    Parameters:
    - (Exception) error data.
    See Also:
    
    Constant Field Values
  - EVENT_MESSAGE
```
public static final String EVENT_MESSAGE
```
    See Also:
    
    Constant Field Values
  - EVENT_CONNECT_ERROR
```
public static final String EVENT_CONNECT_ERROR
```
    See Also:
    
    Constant Field Values
  - EVENT_CONNECT_TIMEOUT
```
public static final String EVENT_CONNECT_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - EVENT_RECONNECT
```
public static final String EVENT_RECONNECT
```
    See Also:
    
    Constant Field Values
  - EVENT_RECONNECT_ERROR
```
public static final String EVENT_RECONNECT_ERROR
```
    See Also:
    
    Constant Field Values
  - EVENT_RECONNECT_FAILED
```
public static final String EVENT_RECONNECT_FAILED
```
    See Also:
    
    Constant Field Values
  - EVENT_RECONNECT_ATTEMPT
```
public static final String EVENT_RECONNECT_ATTEMPT
```
    See Also:
    
    Constant Field Values
  - EVENT_RECONNECTING
```
public static final String EVENT_RECONNECTING
```
    See Also:
    
    Constant Field Values
  - EVENT_PING
```
public static final String EVENT_PING
```
    See Also:
    
    Constant Field Values
  - EVENT_PONG
```
public static final String EVENT_PONG
```
    See Also:
    
    Constant Field Values
  - events
```
protected static Map<String,Integer> events
```
- Constructor Detail
  - Socket
```
public Socket(Manager io,
              String nsp,
              Manager.Options opts)
```
- Method Detail
  - 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

Class Socket

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class io.socket.emitter.Emitter

Methods inherited from class java.lang.Object

Field Detail

EVENT_CONNECT

EVENT_CONNECTING

EVENT_DISCONNECT

EVENT_ERROR

EVENT_MESSAGE

EVENT_CONNECT_ERROR

EVENT_CONNECT_TIMEOUT

EVENT_RECONNECT

EVENT_RECONNECT_ERROR

EVENT_RECONNECT_FAILED

EVENT_RECONNECT_ATTEMPT

EVENT_RECONNECTING

EVENT_PING

EVENT_PONG

events

Constructor Detail

Socket

Method Detail

open

connect

send

emit

emit

close

disconnect

io

connected

id