org.atmosphere.vibe.server

Interface Server

All Known Implementing Classes:

ClusteredServer, DefaultServer

public interface Server

Interface used to interact with sockets.

Server consumes ServerHttpExchange and ServerWebSocket, produces ServerSocket following the Vibe protocol and manages their life cycles. Server API is used to receive ServerHttpExchange and ServerWebSocket from the platform and accept, find and handle ServerSocket.

Server 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(org.atmosphere.vibe.platform.Action<ServerSocket> action) Executes the given action retrieving every socket in this server.
Sentence	byId(String id) Returns a sentence that the socket of the given id in this server have to follow.
Server	byId(String id, org.atmosphere.vibe.platform.Action<ServerSocket> action) Executes the given action retrieving the socket of the given id 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, org.atmosphere.vibe.platform.Action<ServerSocket> action) Executes the given action retrieving the socket tagged with the given tags in this server.
Server	byTag(String name, org.atmosphere.vibe.platform.Action<ServerSocket> action) Executes the given action retrieving the socket tagged with the given tag in this server.
org.atmosphere.vibe.platform.Action<org.atmosphere.vibe.platform.server.ServerHttpExchange>	httpAction() An action to consume ServerHttpExchange.
Server	socketAction(org.atmosphere.vibe.platform.Action<ServerSocket> action) Registers an action to be called when the socket has been opened in this server.
org.atmosphere.vibe.platform.Action<org.atmosphere.vibe.platform.server.ServerWebSocket>	wsAction() An action to consume ServerWebSocket.

Method Detail

all

Sentence all()

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

all

Server all(org.atmosphere.vibe.platform.Action<ServerSocket> action)

Executes the given action retrieving every socket in this server.

byId

Sentence byId(String id)

Returns a sentence that the socket of the given id in this server have to follow.

byId

Server byId(String id,
          org.atmosphere.vibe.platform.Action<ServerSocket> action)

Executes the given action retrieving the socket of the given id in this server. The given action will be executed only once if socket is found and won't be executed if not found.

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,
           org.atmosphere.vibe.platform.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,
           org.atmosphere.vibe.platform.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(org.atmosphere.vibe.platform.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.

httpAction

org.atmosphere.vibe.platform.Action<org.atmosphere.vibe.platform.server.ServerHttpExchange> httpAction()

An action to consume ServerHttpExchange.

wsAction

org.atmosphere.vibe.platform.Action<org.atmosphere.vibe.platform.server.ServerWebSocket> wsAction()

An action to consume ServerWebSocket.