EventManager Protocol Reference
Conforms to | EventListenersResolver Transactable |
---|---|
Declared in | EventManger.h |
– registerEventFamily:
required method
Add event family object which can handle specified event.
- (void)registerEventFamily:(id<BaseEventFamily>)eventFamily
Discussion
Add event family object which can handle specified event.
Declared In
EventManger.h
– produceEventWithFQN:data:target:
required method
Creates an Event and passes it to OPS
- (void)produceEventWithFQN:(NSString *)eventFQN data:(NSData *)data target:(NSString *)target
Parameters
eventFqn |
Fully qualified name of the Event |
---|---|
data |
Event data |
target |
Event target, nil for event broadcasting. |
Discussion
Creates an Event and passes it to OPS
Declared In
EventManger.h
– produceEventWithFQN:data:target:transactionId:
required method
Creates an Event and passes it to OPS
- (void)produceEventWithFQN:(NSString *)eventFQN data:(NSData *)data target:(NSString *)target transactionId:(TransactionId *)transactionId
Parameters
eventFqn |
Fully qualified name of the Event |
---|---|
data |
Event data |
target |
Event target, nil for event broadcasting. |
trxId |
Transaction Id of event |
Discussion
Creates an Event and passes it to OPS
Declared In
EventManger.h
– onGenericEvent:withData:fromSource:
required method
Retrieves an event.
- (void)onGenericEvent:(NSString *)eventFQN withData:(NSData *)data fromSource:(NSString *)source
Parameters
eventFqn |
Fully qualified name of the Event |
---|---|
data |
Event data |
source |
Event source |
Discussion
Retrieves an event.
Declared In
EventManger.h
– eventListenersResponseReceived:
required method
Called when SyncResponse contains resolved array of endpoints which support FQNs given in a request before.
- (void)eventListenersResponseReceived:(NSArray *)response
Parameters
response |
Array of responses. |
---|
Discussion
Called when SyncResponse contains resolved array of endpoints which support FQNs given in a request before.
Declared In
EventManger.h
– fillEventListenersSyncRequest:
required method
Adds new event listener requests to the given Sync request.
- (void)fillEventListenersSyncRequest:(EventSyncRequest *)request
Parameters
request |
Event sync request. |
---|
Discussion
Adds new event listener requests to the given Sync request.
Declared In
EventManger.h
– pollPendingEvents
required method
Retrieves and clears list of pending events and removes them from EventManager.
- (NSArray *)pollPendingEvents
Return Value
Array of
Discussion
Retrieves and clears list of pending events and removes them from EventManager.
Declared In
EventManger.h
– peekPendingEvents
required method
Peek but not clear list of pending events and removes them from EventManager.
- (NSArray *)peekPendingEvents
Return Value
Array of
Discussion
Peek but not clear list of pending events and removes them from EventManager.
Declared In
EventManger.h
– clearState
required method
Clears the current manager’s state.
- (void)clearState
Discussion
Clears the current manager’s state.
Declared In
EventManger.h
– engageDataChannel
required method
Restrict manager to use data channel until releaseDataChannel is called.
- (void)engageDataChannel
Discussion
Restrict manager to use data channel until releaseDataChannel is called.
Declared In
EventManger.h
– releaseDataChannel
required method
Allow manager to use data channel.
- (BOOL)releaseDataChannel
Return Value
YES if there is data to be sent via data channel
NO otherwise
Discussion
Allow manager to use data channel.
Declared In
EventManger.h