org.atmosphere.vibe.server

Interface ServerSocket

All Superinterfaces:

AbstractServerSocket<ServerSocket>, org.atmosphere.vibe.platform.Wrapper

public interface ServerSocket
extends AbstractServerSocket<ServerSocket>, org.atmosphere.vibe.platform.Wrapper

Interface used to interact with the remote socket.

ServerSocket produced by Server is used to send and receive event to and from the remote socket. The normal usage to use ServerSocket is to create a socket action and pass it to Server. If you are going to hold a reference on ServerSocket, you should do something when it is closed through closeAction(Action).

Sockets may be accessed by multiple threads.

Author:

Donghwan Kim

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ServerSocket.Reply<T> Interface to deal with reply.

Method Summary

Methods

Modifier and Type	Method and Description
ServerSocket	closeAction(org.atmosphere.vibe.platform.Action<Void> action) Executed if the socket is closed for any reason.
ServerSocket	errorAction(org.atmosphere.vibe.platform.Action<Throwable> action) Executed if there was any error on the socket.
String	id() A unique identifier.
<T> ServerSocket	off(String event, org.atmosphere.vibe.platform.Action<T> action) Removes a given event handler for a given event.
<T> ServerSocket	on(String event, org.atmosphere.vibe.platform.Action<T> action) Adds a given event handler for a given event.
<T> ServerSocket	send(String event, Object data, org.atmosphere.vibe.platform.Action<T> resolved) Sends a given event with data attaching resolved callback.
<T,U> ServerSocket	send(String event, Object data, org.atmosphere.vibe.platform.Action<T> resolved, org.atmosphere.vibe.platform.Action<U> rejected) Sends a given event with data attaching resolved callback and rejected callback.
Set<String>	tags() A modifiable set of tag names.
String	uri() A URI used to connect.

Methods inherited from interface org.atmosphere.vibe.server.AbstractServerSocket

close, send, send, tag, untag

Methods inherited from interface org.atmosphere.vibe.platform.Wrapper

unwrap

Method Detail

id

String id()

A unique identifier.

uri

String uri()

A URI used to connect. To work with URI parts, use URI or something like that.

tags

Set<String> tags()

A modifiable set of tag names.

on

<T> ServerSocket on(String event,
                  org.atmosphere.vibe.platform.Action<T> action)

Adds a given event handler for a given event.

The allowed types for T are Java types corresponding to JSON types.

JSON	Java
Number	Integer or Double
String	String
Boolean	Boolean
Array	List, List<T> in generic
Object	Map, Map<String, T> in generic
null	null, Void for convenience

If the counterpart sends an event with callback, T should be ServerSocket.Reply.

closeAction

ServerSocket closeAction(org.atmosphere.vibe.platform.Action<Void> action)

Executed if the socket is closed for any reason. Equivalent to socket.on("close", action)

errorAction

ServerSocket errorAction(org.atmosphere.vibe.platform.Action<Throwable> action)

Executed if there was any error on the socket. You don't need to close it explicitly. Equivalent to socket.on("error", action)

off

<T> ServerSocket off(String event,
                   org.atmosphere.vibe.platform.Action<T> action)

Removes a given event handler for a given event.

send

<T> ServerSocket send(String event,
                    Object data,
                    org.atmosphere.vibe.platform.Action<T> resolved)

Sends a given event with data attaching resolved callback.

For the allowed types for T, see on(String, Action).

send

<T,U> ServerSocket send(String event,
                      Object data,
                      org.atmosphere.vibe.platform.Action<T> resolved,
                      org.atmosphere.vibe.platform.Action<U> rejected)

Sends a given event with data attaching resolved callback and rejected callback.

For the allowed types for T, see on(String, Action).