org.atmosphere.vibe

Class DefaultServer

java.lang.Object

org.atmosphere.vibe.DefaultServer

All Implemented Interfaces:

Action<ServerTransport>, Server

Direct Known Subclasses:

ClusteredServer

public class DefaultServer
extends Object
implements Server

Default implementation of Server.

This implementation consumes ServerTransport and produces ServerSocket following the Vibe protocol.

The following options are configurable.

• setHeartbeat(int)

Author:

Donghwan Kim

Constructor Summary

Constructors

Constructor and Description
DefaultServer()

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.
void	on(ServerTransport transport)
void	set_heartbeat(int _heartbeat) To speed up the protocol tests.
void	setHeartbeat(int heartbeat) A heartbeat interval in milliseconds to maintain a connection alive and prevent server from holding idle connections.
Server	socketAction(Action<ServerSocket> action) Registers an action to be called when the socket has been opened in this server.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultServer

public DefaultServer()

Method Detail

on

public void on(ServerTransport transport)

Specified by:

on in interface Action<ServerTransport>

all

public Sentence all()

Description copied from interface: Server

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

Specified by:

all in interface Server

all

public Server all(Action<ServerSocket> action)

Description copied from interface: Server

Executes the given action retrieving every socket in this server.

Specified by:

all in interface Server

byTag

public Sentence byTag(String... names)

Description copied from interface: Server

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

Specified by:

byTag in interface Server

byTag

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

Description copied from interface: Server

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.

Specified by:

byTag in interface Server

byTag

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

Description copied from interface: Server

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.

Specified by:

byTag in interface Server

socketAction

public Server socketAction(Action<ServerSocket> action)

Description copied from interface: Server

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.

Specified by:

socketAction in interface Server

setHeartbeat

public void setHeartbeat(int heartbeat)

A heartbeat interval in milliseconds to maintain a connection alive and prevent server from holding idle connections. The default is 20s and should be larger than 5s.

set_heartbeat

public void set_heartbeat(int _heartbeat)

To speed up the protocol tests. Not for production use.