io.github.flowersinthesand.portal

Interface Server

All Known Implementing Classes:

ClusteredServer, DefaultServer

public interface Server

Interface used to interact with the socket.

A Server instance provides Socket processing HTTP request and WebSocket under the specific URI pattern and manages their life cycles. The Server API is used to accept socket and to find socket by id and tag. If you are using dependency injection support, make a Server as component and inject it wherever you need to handle socket.

The Server is a wes application so can be installed on any platform like Servlet wes supports. For that reason, Server doesn't concern I/O details and I/O details should be configured in the platform following its policy.

Server may be accessed by multiple threads.

Author:

Donghwan Kim

See Also:

Examples to install portal

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(Action<Socket> 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, Action<Socket> 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, Action<Socket> 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, Action<Socket> 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.
Action<ServerHttpExchange>	httpAction() ServerHttpExchange action to install in wes
Server	socketAction(Action<Socket> action) Registers an action to be called when the socket has been opened in this server regardless of clustering.
Action<ServerWebSocket>	websocketAction() ServerWebSocket action to install in wes

Method Detail

all

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.

all

Server all(Action<Socket> 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 .

byId

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.

byId

Server byId(String id,
          Action<Socket> 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. 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 all of the given names in this server or all of the server if it's in a clustered environment have to follow.

byTag

Server byTag(String name,
           Action<Socket> 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. The given action will be executed multiple times if sockets are found and won't be executed if not found.

byTag

Server byTag(String[] names,
           Action<Socket> 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. The given action will be executed multiple times if sockets are found and won't be executed if not found.

socketAction

Server socketAction(Action<Socket> action)

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.

httpAction

Action<ServerHttpExchange> httpAction()

ServerHttpExchange action to install in wes

websocketAction

Action<ServerWebSocket> websocketAction()

ServerWebSocket action to install in wes