angularBeans.realtime

Class RealTimeClient

java.lang.Object

angularBeans.realtime.RealTimeClient

All Implemented Interfaces:

Serializable

@NGSessionScoped
public class RealTimeClient
extends Object
implements Serializable

Author:

bessem when injected, a realTime client represent the current real time session (websocket or fallback protocol)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RealTimeClient()

Method Summary

Methods

Modifier and Type	Method and Description
RealTimeClient	async() the Realtime client will use will use AsyncRemote of the websocket api usage: realTimeClient.async().
void	broadcast(ModelQuery query, boolean withoutMe) send a ModelQuery to all front end open sessions
void	broadcast(String channel, RealTimeMessage message, boolean withoutMe) send a message to all front end open sessions
void	invalidateSession() will close all current realTime sessions bound to the current HTTP session
void	onClose(RealTimeDataReceivedEvent event)
void	onData(RealTimeDataReceivedEvent event)
void	onError(RealTimeDataReceivedEvent event)
void	onSessionReady(RealTimeDataReceivedEvent event)
void	publish(ModelQuery query) send a ModelQuery to the current session front end AngularBean proxy to update his models
void	publish(String channel, RealTimeMessage message) send a message to the current session front end

Methods inherited from class java.lang.Object

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

Constructor Detail

RealTimeClient

public RealTimeClient()

Method Detail

async

public RealTimeClient async()

the Realtime client will use will use AsyncRemote of the websocket api

usage: realTimeClient.async().*any-method()*.

onSessionReady

public void onSessionReady(@Observes
                  RealTimeDataReceivedEvent event)

onClose

public void onClose(@Observes
           RealTimeDataReceivedEvent event)

onError

public void onError(@Observes
           RealTimeDataReceivedEvent event)

onData

public void onData(@Observes
          RealTimeDataReceivedEvent event)

invalidateSession

public void invalidateSession()

will close all current realTime sessions bound to the current HTTP session

publish

public void publish(String channel,
           RealTimeMessage message)

send a message to the current session front end

Parameters:

channel - : can be - The AngularBean class name OR A custom channel

message - : the RealTimeMessage to send

publish

public void publish(ModelQuery query)

send a ModelQuery to the current session front end AngularBean proxy to update his models

Parameters:

query - : the ModelQuery to send

broadcast

public void broadcast(String channel,
             RealTimeMessage message,
             boolean withoutMe)

send a message to all front end open sessions

Parameters:

channel - : can be - The AngularBean class name - A custom channel

message - : the RealTimeMessage to send

withoutMe - : possible values:

true: the current session client will not receive the message.

false: the current session client will also receive the message.

broadcast

public void broadcast(ModelQuery query,
             boolean withoutMe)

send a ModelQuery to all front end open sessions

Parameters:

query - : the ModelQuery to send

withoutMe - : possible values:

true: the current session client will not receive the query.

false: the current session client will also receive the query.