de.novanic.eventservice.client.connection.strategy.connector

Interface RemoteEventConnector

public interface RemoteEventConnector

The RemoteEventConnector should handle the connection between the client and the server side.

Author:

sstrohschein
Date: 12.10.2008
Time: 11:16:14

Method Summary

Methods

Modifier and Type	Method and Description
void	activate(Domain aDomain, EventFilter anEventFilter, EventNotification anEventNotification, AsyncCallback<Void> aCallback) Activates the connector for the domain.
void	deactivate() Deactivates the connector for all domains (no events can be got from the domains).
void	deactivate(Domain aDomain, AsyncCallback<Void> aCallback) Deactivates the connector for the domain (no events can be got from the domain).
void	deactivate(Set<Domain> aDomains, AsyncCallback<Void> aCallback) Deactivates the connector for the domains (no events can be got from the domains).
void	deregisterEventFilter(Domain aDomain, AsyncCallback<Void> aCallback) Deregisters the EventFilter for a domain.
void	init(AsyncCallback<EventServiceConfigurationTransferable> aCallback) That method is called to execute the first server call (for initialization).
ConnectionStrategyClientConnector	initListen(EventServiceConfigurationTransferable aConfiguration) Initializes the listen method implementation with a ConnectionStrategyClientConnector from the configuration.
boolean	isActive() Checks if the connector is active (listening).
void	registerEventFilter(Domain aDomain, EventFilter anEventFilter, AsyncCallback<Void> aCallback) Registers an EventFilter for a domain.
void	registerUnlistenEvent(UnlistenEventListener.Scope anUnlistenScope, UnlistenEvent anUnlistenEvent, AsyncCallback<Void> aCallback) Registers an UnlistenEvent to the server side which will be triggered when a timeout or unlisten/deactivation for a domain occurs.
void	sendEvent(Domain aDomain, Event anEvent, AsyncCallback<Void> aCallback) Sends an event to a domain.

Method Detail

init

void init(AsyncCallback<EventServiceConfigurationTransferable> aCallback)

That method is called to execute the first server call (for initialization).

Parameters:

aCallback - callback

initListen

ConnectionStrategyClientConnector initListen(EventServiceConfigurationTransferable aConfiguration)

Initializes the listen method implementation with a ConnectionStrategyClientConnector from the configuration. That is required to specify the listen / connection strategy.

Parameters:

aConfiguration - configuration

activate

void activate(Domain aDomain,
            EventFilter anEventFilter,
            EventNotification anEventNotification,
            AsyncCallback<Void> aCallback)

Activates the connector for the domain. An EventFilter to filter events on the server side is optional.

Parameters:

aDomain - domain to activate

anEventFilter - EventFilter to filter the events on the server side (optional)

anEventNotification - supports the notification about incoming events

aCallback - callback

deactivate

void deactivate()

Deactivates the connector for all domains (no events can be got from the domains).

deactivate

void deactivate(Set<Domain> aDomains,
              AsyncCallback<Void> aCallback)

Deactivates the connector for the domains (no events can be got from the domains).

Parameters:

aDomains - domains to deactivate

aCallback - callback

deactivate

void deactivate(Domain aDomain,
              AsyncCallback<Void> aCallback)

Deactivates the connector for the domain (no events can be got from the domain).

Parameters:

aDomain - domain to deactivate

aCallback - callback

isActive

boolean isActive()

Checks if the connector is active (listening).

Returns:

true when active/listening, otherwise false

sendEvent

void sendEvent(Domain aDomain,
             Event anEvent,
             AsyncCallback<Void> aCallback)

Sends an event to a domain. The event will be received from all clients which are registered to that domain. User-specific events can be sent with the usage of this domain: DomainFactory.USER_SPECIFIC_DOMAIN.

Parameters:

aDomain - domain

anEvent - event

aCallback - callback

registerUnlistenEvent

void registerUnlistenEvent(UnlistenEventListener.Scope anUnlistenScope,
                         UnlistenEvent anUnlistenEvent,
                         AsyncCallback<Void> aCallback)

Registers an UnlistenEvent to the server side which will be triggered when a timeout or unlisten/deactivation for a domain occurs.

Parameters:

anUnlistenScope - scope of the unlisten events to receive

anUnlistenEvent - UnlistenEvent which can contain custom data

aCallback - callback

registerEventFilter

void registerEventFilter(Domain aDomain,
                       EventFilter anEventFilter,
                       AsyncCallback<Void> aCallback)

Registers an EventFilter for a domain. That can be used when the domain is already activated and an EventFilter is needed later or isn't available when the domain becomes active.

Parameters:

aDomain - domain

anEventFilter - EventFilter to filter the events on the server side (optional)

aCallback - callback

deregisterEventFilter

void deregisterEventFilter(Domain aDomain,
                         AsyncCallback<Void> aCallback)

Deregisters the EventFilter for a domain.

Parameters:

aDomain - domain to remove the EventFilter from

aCallback - callback