org.atmosphere.vibe.server

Class DefaultServer

java.lang.Object

org.atmosphere.vibe.server.DefaultServer

All Implemented Interfaces:

Server

Direct Known Subclasses:

ClusteredServer

public class DefaultServer
extends Object
implements Server

Default implementation of Server.

This implementation provides and manages ServerSocket processing HTTP request and WebSocket following the Vibe protocol.

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 all of the socket in this server or all of the server if it's in a clustered environment have to follow.
Server	all(org.atmosphere.vibe.platform.Action<ServerSocket> action) Executes the given action retrieving all of the socket in this server or all of the server if it's in a clustered environment .
Sentence	byId(String id) Returns a sentence that the socket of the given id in this server or all of the server if it's in a clustered environment 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 or all of the server if it's in a clustered environment.
Sentence	byTag(String... names) Returns a sentence that the socket tagged with all of the given names in this server or all of the server if it's in a clustered environment have to follow.
Server	byTag(String[] names, org.atmosphere.vibe.platform.Action<ServerSocket> action) Executes the given action retrieving the socket tagged with all of the given names in this server or all of the server if it's in a clustered environment.
Server	byTag(String name, org.atmosphere.vibe.platform.Action<ServerSocket> action) Executes the given action retrieving the socket tagged with the given name in this server or all of the server if it's in a clustered environment.
org.atmosphere.vibe.platform.Action<org.atmosphere.vibe.platform.server.ServerHttpExchange>	httpAction() ServerHttpExchange action to install in wes
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.
void	setTransports(String... transports) A set of transports to allow connections.
Server	socketAction(org.atmosphere.vibe.platform.Action<ServerSocket> action) Registers an action to be called when the socket has been opened in this server regardless of clustering.
org.atmosphere.vibe.platform.Action<org.atmosphere.vibe.platform.server.ServerWebSocket>	websocketAction() ServerWebSocket action to install in wes

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

all

public Sentence all()

Description copied from interface: Server

Returns a sentence that all of the socket in this server or all of the server if it's in a clustered environment have to follow.

Specified by:

all in interface Server

all

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

Description copied from interface: Server

Executes the given action retrieving all of the socket in this server or all of the server if it's in a clustered environment .

Specified by:

all in interface Server

byId

public Sentence byId(String id)

Description copied from interface: Server

Returns a sentence that the socket of the given id in this server or all of the server if it's in a clustered environment have to follow.

Specified by:

byId in interface Server

byId

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

Description copied from interface: Server

Executes the given action retrieving the socket of the given id in this server or all of the server if it's in a clustered environment. The given action will be executed only once if socket is found and won't be executed if not found.

Specified by:

byId in interface Server

byTag

public Sentence byTag(String... names)

Description copied from interface: Server

Returns a sentence that the socket tagged with all of the given names in this server or all of the server if it's in a clustered environment have to follow.

Specified by:

byTag in interface Server

byTag

public Server byTag(String name,
           org.atmosphere.vibe.platform.Action<ServerSocket> action)

Description copied from interface: Server

Executes the given action retrieving the socket tagged with the given name in this server or all of the server if it's in a clustered environment. The given action will be executed multiple times if sockets are found and won't be executed if not found.

Specified by:

byTag in interface Server

byTag

public Server byTag(String[] names,
           org.atmosphere.vibe.platform.Action<ServerSocket> action)

Description copied from interface: Server

Executes the given action retrieving the socket tagged with all of the given names in this server or all of the server if it's in a clustered environment. The given action will be executed multiple times if sockets are found and won't be executed if not found.

Specified by:

byTag in interface Server

socketAction

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

Description copied from interface: Server

Registers an action to be called when the socket has been opened in this server regardless of clustering. It's allowed to add several actions before and after installation, so you don't need to centralize all your code to one class.

Specified by:

socketAction in interface Server

httpAction

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

Description copied from interface: Server

ServerHttpExchange action to install in wes

Specified by:

httpAction in interface Server

websocketAction

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

Description copied from interface: Server

ServerWebSocket action to install in wes

Specified by:

websocketAction in interface Server

setTransports

public void setTransports(String... transports)

A set of transports to allow connections. The default is ws, sse, streamxhr, streamxdr, streamiframe, longpollajax, longpollxdr and longpolljsonp.

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.