org.atmosphere.vibe

Interface Server

All Superinterfaces:

Action<ServerTransport>

All Known Implementing Classes:

ClusteredServer, DefaultServer

public interface Server
extends Action<ServerTransport>

Interface used to interact with sockets.

Server consumes ServerTransport and produces ServerSocket following the Vibe protocol.

Instances may be accessed by multiple threads.

Author:

Donghwan Kim

Method Summary

Methods

Modifier and Type	Method and Description
Sentence	all() Returns a sentence that every socket in this server have to follow.
Server	all(Action<ServerSocket> action) Executes the given action retrieving every socket in this server.
Sentence	byTag(String... names) Returns a sentence that the socket tagged with the given tags in this server have to follow.
Server	byTag(String[] names, Action<ServerSocket> action) Executes the given action retrieving the socket tagged with the given tags in this server.
Server	byTag(String name, Action<ServerSocket> action) Executes the given action retrieving the socket tagged with the given tag in this server.
Server	socketAction(Action<ServerSocket> action) Registers an action to be called when the socket has been opened in this server.

Methods inherited from interface org.atmosphere.vibe.platform.action.Action

on

Method Detail

all

Sentence all()

Returns a sentence that every socket in this server have to follow.

all

Server all(Action<ServerSocket> action)

Executes the given action retrieving every socket in this server.

byTag

Sentence byTag(String... names)

Returns a sentence that the socket tagged with the given tags in this server have to follow.

byTag

Server byTag(String name,
           Action<ServerSocket> action)

Executes the given action retrieving the socket tagged with the given tag in this server. The given action will be executed multiple times per socket if sockets are found and won't be executed if not found.

byTag

Server byTag(String[] names,
           Action<ServerSocket> action)

Executes the given action retrieving the socket tagged with the given tags in this server. The given action will be executed multiple times per socket if sockets are found and won't be executed if not found.

socketAction

Server socketAction(Action<ServerSocket> action)

Registers an action to be called when the socket has been opened in this server. It's allowed to add several actions at any time, so you don't need to centralize all your code to one class.