A B C D F H I M O P S T U W

A

all(Action<Socket>) - Method in class io.github.flowersinthesand.portal.ClusteredServer

all() - Method in class io.github.flowersinthesand.portal.DefaultServer

all(Action<Socket>) - Method in class io.github.flowersinthesand.portal.DefaultServer

all() - Method in interface io.github.flowersinthesand.portal.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.

all(Action<Socket>) - Method in interface io.github.flowersinthesand.portal.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 .

B

byId(String, Action<Socket>) - Method in class io.github.flowersinthesand.portal.ClusteredServer

byId(String) - Method in class io.github.flowersinthesand.portal.DefaultServer

byId(String, Action<Socket>) - Method in class io.github.flowersinthesand.portal.DefaultServer

byId(String) - Method in interface io.github.flowersinthesand.portal.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.

byId(String, Action<Socket>) - Method in interface io.github.flowersinthesand.portal.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.

byTag(String[], Action<Socket>) - Method in class io.github.flowersinthesand.portal.ClusteredServer

byTag(String...) - Method in class io.github.flowersinthesand.portal.DefaultServer

byTag(String, Action<Socket>) - Method in class io.github.flowersinthesand.portal.DefaultServer

byTag(String[], Action<Socket>) - Method in class io.github.flowersinthesand.portal.DefaultServer

byTag(String...) - Method in interface io.github.flowersinthesand.portal.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.

byTag(String, Action<Socket>) - Method in interface io.github.flowersinthesand.portal.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.

byTag(String[], Action<Socket>) - Method in interface io.github.flowersinthesand.portal.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.

C

close() - Method in class io.github.flowersinthesand.portal.Sentence

With respect to sockets, closes the session.

close() - Method in interface io.github.flowersinthesand.portal.Socket

Closes the session.

ClusteredServer - Class in io.github.flowersinthesand.portal

Server implementation for clustering.

ClusteredServer() - Constructor for class io.github.flowersinthesand.portal.ClusteredServer

contextDestroyed(ServletContextEvent) - Method in class io.github.flowersinthesand.portal.testsuite.ServerBootstrap

contextInitialized(ServletContextEvent) - Method in class io.github.flowersinthesand.portal.testsuite.ServerBootstrap

D

data() - Method in interface io.github.flowersinthesand.portal.Socket.Reply

The original data.

DefaultServer - Class in io.github.flowersinthesand.portal

Default implementation of Server.

DefaultServer() - Constructor for class io.github.flowersinthesand.portal.DefaultServer

done() - Method in interface io.github.flowersinthesand.portal.Socket.Reply

Replies with success.

done(Object) - Method in interface io.github.flowersinthesand.portal.Socket.Reply

Replies with success attaching data.

F

fail() - Method in interface io.github.flowersinthesand.portal.Socket.Reply

Replies with failure.

fail(Object) - Method in interface io.github.flowersinthesand.portal.Socket.Reply

Replies with failure attaching data.

H

httpAction() - Method in class io.github.flowersinthesand.portal.DefaultServer

httpAction() - Method in interface io.github.flowersinthesand.portal.Server

ServerHttpExchange action to install in wes

I

id() - Method in interface io.github.flowersinthesand.portal.Socket

A unique identifier in the form of UUID generated by client by default.

io.github.flowersinthesand.portal - package io.github.flowersinthesand.portal

io.github.flowersinthesand.portal.testsuite - package io.github.flowersinthesand.portal.testsuite

M

messageAction() - Method in class io.github.flowersinthesand.portal.ClusteredServer

This action receives a map fired from one of node in cluster and invokes socket action in this server.

O

off(String, Action<T>) - Method in interface io.github.flowersinthesand.portal.Socket

Removes a given added event handler for a given event.

on(String, Action<T>) - Method in interface io.github.flowersinthesand.portal.Socket

Adds a given event handler for a given event.

P

parseEvent(String) - Method in class io.github.flowersinthesand.portal.DefaultServer

Takes a stringified event and returns an event object.

parseURI(String) - Method in class io.github.flowersinthesand.portal.DefaultServer

Takes a portal URI and returns a map of parameters.

publishAction(Action<Map<String, Object>>) - Method in class io.github.flowersinthesand.portal.ClusteredServer

Attaches an action to be called with a map containing method name and arguments of socket action when it's called.

S

send(String) - Method in class io.github.flowersinthesand.portal.Sentence

With respect to sockets, sends a given event without data.

send(String, Object) - Method in class io.github.flowersinthesand.portal.Sentence

With respect to sockets, sends a given event with data.

send(String) - Method in interface io.github.flowersinthesand.portal.Socket

Sends a given event without data.

send(String, Object) - Method in interface io.github.flowersinthesand.portal.Socket

Sends a given event with data.

send(String, Object, Action<T>) - Method in interface io.github.flowersinthesand.portal.Socket

Sends a given event with data registering callback.

Sentence - Class in io.github.flowersinthesand.portal

Sentence is a series of predicates that a group of socket have to follow.

Server - Interface in io.github.flowersinthesand.portal

Interface used to interact with the socket.

ServerBootstrap - Class in io.github.flowersinthesand.portal.testsuite

Bootstrap to start the test suite server.

ServerBootstrap() - Constructor for class io.github.flowersinthesand.portal.testsuite.ServerBootstrap

Socket - Interface in io.github.flowersinthesand.portal

Socket is a connectivity between the two portal endpoints.

Socket.Reply<T> - Interface in io.github.flowersinthesand.portal

Interface to deal with reply.

socketAction(Action<Socket>) - Method in class io.github.flowersinthesand.portal.DefaultServer

socketAction(Action<Socket>) - Method in interface io.github.flowersinthesand.portal.Server

Registers an action to be called when the socket has been opened in this server regardless of clustering.

stringifyEvent(Map<String, Object>) - Method in class io.github.flowersinthesand.portal.DefaultServer

Takes an event object and returns a stringified event.

T

tags() - Method in interface io.github.flowersinthesand.portal.Socket

A set of tag names.

U

uri() - Method in interface io.github.flowersinthesand.portal.Socket

A URI used to connect.

W

websocketAction() - Method in class io.github.flowersinthesand.portal.DefaultServer

websocketAction() - Method in interface io.github.flowersinthesand.portal.Server

ServerWebSocket action to install in wes

A B C D F H I M O P S T U W