org.kaaproject.kaa.client.event

Interface EventManager

All Superinterfaces:

EventListenersResolver, Transactable

All Known Implementing Classes:

DefaultEventManager

public interface EventManager
extends EventListenersResolver, Transactable

Interface for event management.

Author:

Taras Lemkin

Method Summary

Modifier and Type	Method and Description
void	clearState() Clears the current manager's state.
void	engageDataChannel() Restrict manager to use data channel until releaseDataChannel() called
void	eventListenersResponseReceived(List<org.kaaproject.kaa.common.endpoint.gen.EventListenersResponse> response) Called when SyncResponse contains resolved list of endpoints which support FQNs given in a request before.
void	fillEventListenersSyncRequest(org.kaaproject.kaa.common.endpoint.gen.EventSyncRequest request) Adds new event listener requests to the given Sync request.
void	onGenericEvent(String eventFqn, byte[] data, String source) Retrieves an event.
List<org.kaaproject.kaa.common.endpoint.gen.Event>	peekPendingEvents() Peek but not clear list of pending events and removes them from EventManager.
List<org.kaaproject.kaa.common.endpoint.gen.Event>	pollPendingEvents() Retrieves and clears list of pending events and removes them from EventManager.
void	produceEvent(String eventFqn, byte[] data, String target) Creates an Event and passes it to OPS
void	produceEvent(String eventFqn, byte[] data, String target, TransactionId trxId) Creates an Event and passes it to OPS
void	registerEventFamily(EventFamily eventFamily) Add event family object which can handle specified event.
boolean	releaseDataChannel() Allow manager to use data channel.

Methods inherited from interface org.kaaproject.kaa.client.event.EventListenersResolver

findEventListeners

Methods inherited from interface org.kaaproject.kaa.client.transact.Transactable

beginTransaction, commit, rollback

Method Detail

registerEventFamily

void registerEventFamily(EventFamily eventFamily)

Add event family object which can handle specified event.

Parameters:

eventFamily - EventFamily instance

See Also:

EventFamily

produceEvent

void produceEvent(String eventFqn,
                  byte[] data,
                  String target)

Creates an Event and passes it to OPS

Parameters:

eventFqn - Fully qualified name of the Event

data - Event data

target - Event target, null for event broadcasting.

produceEvent

void produceEvent(String eventFqn,
                  byte[] data,
                  String target,
                  TransactionId trxId)

Creates an Event and passes it to OPS

Parameters:

eventFqn - Fully qualified name of the Event

data - Event data

target - Event target, null for event broadcasting.

trxId - Transaction Id of event

onGenericEvent

void onGenericEvent(String eventFqn,
                    byte[] data,
                    String source)

Retrieves an event.

Parameters:

eventFqn - Fully qualified name of the Event

data - Event data

source - Event source

eventListenersResponseReceived

void eventListenersResponseReceived(List<org.kaaproject.kaa.common.endpoint.gen.EventListenersResponse> response)

Called when SyncResponse contains resolved list of endpoints which support FQNs given in a request before.

Parameters:

response - List of responses.

See Also:

EventListenersResponse

fillEventListenersSyncRequest

void fillEventListenersSyncRequest(org.kaaproject.kaa.common.endpoint.gen.EventSyncRequest request)

Adds new event listener requests to the given Sync request.

Parameters:

request - the Event sync request.

See Also:

EventSyncRequest

pollPendingEvents

List<org.kaaproject.kaa.common.endpoint.gen.Event> pollPendingEvents()

Retrieves and clears list of pending events and removes them from EventManager.

Returns:

List of Event objects

See Also:

Event

peekPendingEvents

List<org.kaaproject.kaa.common.endpoint.gen.Event> peekPendingEvents()

Peek but not clear list of pending events and removes them from EventManager.

Returns:

List of Event objects

See Also:

Event

clearState

void clearState()

Clears the current manager's state.

engageDataChannel

void engageDataChannel()

Restrict manager to use data channel until releaseDataChannel() called

releaseDataChannel

boolean releaseDataChannel()

Allow manager to use data channel.

Returns:

true if there is data to be sent via data channel
false otherwise