|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectio.socket.IOConnection
class IOConnection
The Class IOConnection.
Field Summary | |
---|---|
(package private) java.util.HashMap<java.lang.Integer,IOAcknowledge> |
acknowledge
Acknowledges. |
static IOCallback |
DUMMY_CALLBACK
A dummy callback used when IOConnection receives a unexpected message. |
static java.lang.String |
FRAME_DELIMITER
|
(package private) static java.util.logging.Logger |
logger
Debug logger |
static java.lang.String |
SOCKET_IO_1
Socket.io path. |
Method Summary | |
---|---|
void |
emit(SocketIO socket,
java.lang.String event,
IOAcknowledge ack,
java.lang.Object... args)
emits an event from SocketIO to the IOTransport . |
protected void |
error(SocketIOException e)
Populates an error to the connected IOCallback s and shuts down. |
java.lang.String |
getSessionId()
Returns the session id. |
IOTransport |
getTransport()
gets the currently used transport. |
boolean |
isConnected()
Checks if IOConnection is currently connected. |
void |
on(java.lang.String event,
IOAcknowledge ack,
java.lang.Object... args)
On [Event]. |
void |
onConnect()
On connect. |
void |
onDisconnect()
On disconnect. |
void |
onError(SocketIOException socketIOException)
On error. |
void |
onMessage(org.json.JSONObject json,
IOAcknowledge ack)
On message. |
void |
onMessage(java.lang.String data,
IOAcknowledge ack)
On message. |
void |
reconnect()
forces a reconnect. |
boolean |
register(SocketIO socket)
Connects a socket to the IOConnection. |
static IOConnection |
register(java.lang.String origin,
SocketIO socket)
Creates a new connection or returns the corresponding one. |
void |
send(SocketIO socket,
IOAcknowledge ack,
org.json.JSONObject json)
sends a JSON message from SocketIO to the IOTransport . |
void |
send(SocketIO socket,
IOAcknowledge ack,
java.lang.String text)
sends a String message from SocketIO to the IOTransport . |
void |
transportConnected()
Transport connected. |
void |
transportData(java.lang.String text)
IOTransport should call this function if it does not support framing. |
void |
transportDisconnected()
Transport disconnected. |
void |
transportError(java.lang.Exception error)
Transport error. |
void |
transportMessage(java.lang.String text)
Transport message. |
void |
unregister(SocketIO socket)
Disconnect a socket from the IOConnection. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
static final java.util.logging.Logger logger
public static final java.lang.String FRAME_DELIMITER
public static final java.lang.String SOCKET_IO_1
java.util.HashMap<java.lang.Integer,IOAcknowledge> acknowledge
public static final IOCallback DUMMY_CALLBACK
Method Detail |
---|
public static IOConnection register(java.lang.String origin, SocketIO socket)
origin
- the originsocket
- the socket
protected void error(SocketIOException e)
IOCallback
s and shuts down.
e
- an exceptionpublic boolean register(SocketIO socket)
socket
- the socket to be connected
public void unregister(SocketIO socket)
socket
- the socket to be shut downpublic void transportConnected()
IOTransport
calls this when a connection is established.
public void transportDisconnected()
IOTransport
calls this when a connection has been shut down.
public void transportError(java.lang.Exception error)
error
- the error IOTransport
calls this, when an exception
has occurred and the transport is not usable anymore.public void transportData(java.lang.String text)
IOTransport
should call this function if it does not support framing. If it does, transportMessage should be used
text
- the textpublic void transportMessage(java.lang.String text)
IOTransport
calls this, when a message has
been received.
text
- the textpublic void reconnect()
public java.lang.String getSessionId()
IOTransport
public void send(SocketIO socket, IOAcknowledge ack, java.lang.String text)
SocketIO
to the IOTransport
.
socket
- the socketack
- acknowledge package which can be called from the servertext
- the textpublic void send(SocketIO socket, IOAcknowledge ack, org.json.JSONObject json)
SocketIO
to the IOTransport
.
socket
- the socketack
- acknowledge package which can be called from the serverjson
- the jsonpublic void emit(SocketIO socket, java.lang.String event, IOAcknowledge ack, java.lang.Object... args)
SocketIO
to the IOTransport
.
socket
- the socketevent
- the eventack
- acknowledge package which can be called from the serverargs
- the arguments to be sendpublic boolean isConnected()
public IOTransport getTransport()
public void onDisconnect()
IOCallback
onDisconnect
in interface IOCallback
public void onConnect()
IOCallback
onConnect
in interface IOCallback
public void onMessage(java.lang.String data, IOAcknowledge ack)
IOCallback
onMessage
in interface IOCallback
data
- the data.ack
- an IOAcknowledge
instance, may be null
if there's nonepublic void onMessage(org.json.JSONObject json, IOAcknowledge ack)
IOCallback
onMessage
in interface IOCallback
json
- JSON object sent by server.ack
- an IOAcknowledge
instance, may be null
if there's nonepublic void on(java.lang.String event, IOAcknowledge ack, java.lang.Object... args)
IOCallback
on
in interface IOCallback
event
- Name of the eventack
- an IOAcknowledge
instance, may be null
if there's noneargs
- Arguments of the eventpublic void onError(SocketIOException socketIOException)
IOCallback
onError
in interface IOCallback
socketIOException
- the last exception describing the error
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |