org.fujion.client

Class Synchronizer

java.lang.Object

org.fujion.client.Synchronizer

public class Synchronizer
extends Object

Synchronizes state changes from the server to the client.

Constructor Summary

Constructors

Constructor and Description
Synchronizer(org.springframework.web.socket.WebSocketSession session) Create a synchronizer for the specific web socket session.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear the client invocation queue.
Synchronizer	createWidget(BaseComponent parent, OptionMap props, OptionMap state) Creates and sends a client invocation to create a widget.
Synchronizer	invokeClient(IElementIdentifier component, String function, IResponseCallback<?> callback, Object... args) Creates and sends a client invocation to invoke a specified function on a component.
Synchronizer	invokeClient(IElementIdentifier component, String function, Object... args) Creates and sends a client invocation to invoke a specified function on a component.
Synchronizer	processQueue(ClientInvocationQueue queue) Process queued client invocations.
Synchronizer	sendToClient(ClientInvocation invocation) Sends (or queues) a client invocation.
Synchronizer	sendToClient(Collection<ClientInvocation> invocations) Sends (or queues) multiple client invocations.
void	startQueueing() Activate queueing.
void	stopQueueing() Deactivate queueing.

Methods inherited from class java.lang.Object

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

Constructor Detail

Synchronizer

public Synchronizer(org.springframework.web.socket.WebSocketSession session)

Create a synchronizer for the specific web socket session.

Parameters:

session - The web socket session.

Method Detail

startQueueing

public void startQueueing()

Activate queueing. All client invocations will be queued until queueing is deactivated.

stopQueueing

public void stopQueueing()

Deactivate queueing. Any queued invocations will be immediately sent to the client.

clear

public void clear()

Clear the client invocation queue.

createWidget

public Synchronizer createWidget(BaseComponent parent,
                                 OptionMap props,
                                 OptionMap state)

Creates and sends a client invocation to create a widget.

Parameters:

parent - Parent of the new widget.

props - Property values used to initialize the new widget.

state - State values used to initialize the new widget.

Returns:

This synchronizer instance (for chaining).

processQueue

public Synchronizer processQueue(ClientInvocationQueue queue)

Process queued client invocations.

Parameters:

queue - A client invocation queue.

Returns:

This synchronizer instance (for chaining).

invokeClient

public Synchronizer invokeClient(IElementIdentifier component,
                                 String function,
                                 Object... args)

Creates and sends a client invocation to invoke a specified function on a component.

Parameters:

component - Identifier of component whose function is to be invoked.

function - Name of the function to be invoked.

args - Arguments to pass to the functions.

Returns:

This synchronizer instance (for chaining).

invokeClient

public Synchronizer invokeClient(IElementIdentifier component,
                                 String function,
                                 IResponseCallback<?> callback,
                                 Object... args)

Creates and sends a client invocation to invoke a specified function on a component.

Parameters:

component - Identifier of component whose function is to be invoked.

function - Name of the function to be invoked.

callback - Optional callback.

args - Arguments to pass to the functions.

Returns:

This synchronizer instance (for chaining).

sendToClient

public Synchronizer sendToClient(ClientInvocation invocation)

Sends (or queues) a client invocation.

Parameters:

invocation - Client invocation.

Returns:

This synchronizer instance (for chaining).

sendToClient

public Synchronizer sendToClient(Collection<ClientInvocation> invocations)

Sends (or queues) multiple client invocations.

Parameters:

invocations - List of client invocations.

Returns:

This synchronizer instance (for chaining).