io.cettia

Interface ServerSocket

All Superinterfaces:

AbstractServerSocket<ServerSocket>

public interface ServerSocket
extends AbstractServerSocket<ServerSocket>

Interface used to interact with the remote socket.

Instances 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.
static class	ServerSocket.State Enumeration of the state of the socket.

Method Summary

Methods

Modifier and Type	Method and Description
<T> ServerSocket	off(String event, Action<T> action) Removes a given event handler for a given event.
<T> ServerSocket	on(String event, Action<T> action) Adds a given event handler for a given event.
ServerSocket	oncache(Action<Object[]> action) Adds a cache event handler to be called if one of send methods is called when there is no connection.
ServerSocket	onclose(Action<Void> action) Adds a close event handler to be called when the underlying transport is closed for any reason.
ServerSocket	ondelete(Action<Void> action) Adds a delete event handler to be called when the socket is in the closed state for a long time i.e.
ServerSocket	onerror(Action<Throwable> action) Adds an error event handler to be called if there was any error on the socket.
ServerSocket	onopen(Action<Void> action) Adds an open event handler to be called when the handshake is performed successfully and communication is possible.
<T> ServerSocket	send(String event, Object data, Action<T> resolved) Sends a given event with data attaching resolved callback.
<T,U> ServerSocket	send(String event, Object data, Action<T> resolved, Action<U> rejected) Sends a given event with data attaching resolved callback and rejected callback.
ServerSocket.State	state() The current state of the socket.
Set<String>	tags() A modifiable set of tag names.
<T> T	unwrap(Class<T> clazz) Returns the underlying component.
String	uri() A URI used to connect.

Methods inherited from interface io.cettia.AbstractServerSocket

close, send, send, tag, untag

Method Detail

state

ServerSocket.State state()

The current state of the socket.

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,
                  Action<T> action)

Adds a given event handler for a given event.

The allowed types for T is determined by a format which is used to deserialize transport message. Now that format corresponds to Jackson's data format. By default, built-in data format is used for text message, and MessagePack data format is used for binary message.

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

onopen

ServerSocket onopen(Action<Void> action)

Adds an open event handler to be called when the handshake is performed successfully and communication is possible.

Equivalent to socket.on("open", action)

onclose

ServerSocket onclose(Action<Void> action)

Adds a close event handler to be called when the underlying transport is closed for any reason.

Equivalent to socket.on("close", action)

onerror

ServerSocket onerror(Action<Throwable> action)

Adds an error event handler to be called if there was any error on the socket.

Equivalent to socket.on("error", action)

oncache

ServerSocket oncache(Action<Object[]> action)

Adds a cache event handler to be called if one of send methods is called when there is no connection. The given value is an array of arguments of send(String, Object, Action, Action).

Equivalent to socket.on("cache", action)

ondelete

ServerSocket ondelete(Action<Void> action)

Adds a delete event handler to be called when the socket is in the closed state for a long time i.e. 1 minute and deleted from the server. As the end of the life cycle, delete event is called only once.

Equivalent to socket.on("delete", action)

off

<T> ServerSocket off(String event,
                   Action<T> action)

Removes a given event handler for a given event.

send

<T> ServerSocket send(String event,
                    Object data,
                    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,
                      Action<T> resolved,
                      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).

unwrap

<T> T unwrap(Class<T> clazz)

Returns the underlying component.

ServerTransport is available.