org.atmosphere.vibe.server

Class Sentence

java.lang.Object

org.atmosphere.vibe.server.Sentence

All Implemented Interfaces:

AbstractServerSocket<Sentence>

public class Sentence
extends Object
implements AbstractServerSocket<Sentence>

Sentence is a series of predicates that a group of socket have to follow. It makes easy to write one-liner action and uses internally built actions implementing Serializable that is typically needed in cluster environments. Use of Sentence is preferred to that of action if the goal is the same.

Author:

Donghwan Kim

Method Summary

Methods

Modifier and Type	Method and Description
Sentence	close() Closes the socket.
Sentence	send(String event) Sends a given event without data.
Sentence	send(String event, Object data) Sends a given event with data.
Sentence	tag(String... names) Attaches given tags to the socket.
Sentence	untag(String... names) Detaches given tags from the socket.

Methods inherited from class java.lang.Object

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

Method Detail

send

public Sentence send(String event)

Description copied from interface: AbstractServerSocket

Sends a given event without data.

Specified by:

send in interface AbstractServerSocket<Sentence>

send

public Sentence send(String event,
            Object data)

Description copied from interface: AbstractServerSocket

Sends a given event with data.

Specified by:

send in interface AbstractServerSocket<Sentence>

close

public Sentence close()

Description copied from interface: AbstractServerSocket

Closes the socket.

Specified by:

close in interface AbstractServerSocket<Sentence>

tag

public Sentence tag(String... names)

Description copied from interface: AbstractServerSocket

Attaches given tags to the socket.

Specified by:

tag in interface AbstractServerSocket<Sentence>

untag

public Sentence untag(String... names)

Description copied from interface: AbstractServerSocket

Detaches given tags from the socket.

Specified by:

untag in interface AbstractServerSocket<Sentence>