alma.acs.nc

Interface AcsEventPublisher<T>

Type Parameters:

T -

All Known Implementing Classes:

ArchiveSupplier, NCPublisher

public interface AcsEventPublisher<T>

This interface provides an abstraction for an Event Publisher. It can be used both for Corba NC events and in the future also for DDS events.

Author:

rtobar

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	AcsEventPublisher.EventProcessingHandler<U> Handler for optional callbacks to the event publishing client, which allows notifying the client of success or failure with publishing the event(s).

Method Summary

Modifier and Type	Method and Description
void	disconnect() Disconnect this Publisher from the Notification Channel.
void	enableEventQueue(int queueSize, AcsEventPublisher.EventProcessingHandler<T> handler) Deprecated. use increaseEventBufferSize(int) and setEventProcessingHandler(alma.acs.nc.AcsEventPublisher.EventProcessingHandler<T>) instead
int	getEventBufferSize()
boolean	increaseEventBufferSize(int bufferSize) Increase the event buffer size
void	publishEvent(T customStruct) Publishes an event through the Notification Channel to which this publisher is connected to.
void	setEventProcessingHandler(AcsEventPublisher.EventProcessingHandler<T> handler) Sets the event processing handler

Method Detail

publishEvent

void publishEvent(T customStruct)
           throws AcsJException

Publishes an event through the Notification Channel to which this publisher is connected to. (In the future, ACS may use other mechanisms than Corba NC for pub/sub.)

Parameters:

customStruct - The structure to send through the Notification Channel

Throws:

AcsJException - In case of any failure, including if the publisher is not yet connected (or has been disconnected) to the Notification Channel.

disconnect

void disconnect()
         throws AcsJIllegalStateEventEx

Disconnect this Publisher from the Notification Channel. This method must be called when the publisher object is no longer needed.

Throws:

AcsJIllegalStateEventEx - If the current Publisher is already disconnected

enableEventQueue

@Deprecated
void enableEventQueue(int queueSize,
                                  AcsEventPublisher.EventProcessingHandler<T> handler)

Deprecated. use increaseEventBufferSize(int) and setEventProcessingHandler(alma.acs.nc.AcsEventPublisher.EventProcessingHandler<T>) instead

Enables using a queue for published events. When using a queue, a handler must be registered so that the user learns about success or failure.

As of ACS 10.1, only a missing NotifyService as diagnosed through a org.omg.CORBA.TRANSIENT exception will cause the publisher to store an event in this queue for later re-sending.

Parameters:

queueSize - Number of events that this queue should store. The choice is a tradeoff between memory use and data loss.

handler - The handler that should be notified by the publisher.

increaseEventBufferSize

boolean increaseEventBufferSize(int bufferSize)

Increase the event buffer size

Parameters:

bufferSize - new event buffer size

Returns:

true when the event buffer size has been changed, otherwise return false

getEventBufferSize

int getEventBufferSize()

Returns:

current event buffer size

setEventProcessingHandler

void setEventProcessingHandler(AcsEventPublisher.EventProcessingHandler<T> handler)

Sets the event processing handler

Parameters:

handler - event processing handler