ch.agent.crnickl.api

Interface UpdateEventPublisher

All Known Implementing Classes:

UpdateEventPublisherImpl

public interface UpdateEventPublisher

An UpdateEventPublisher takes subscriptions and cancellations to UpdateEvents from UpdateEventSubscribers.

Author:

Jean-Paul Vetterli

Method Summary

Modifier and Type	Method and Description
void	publish(UpdateEvent event, boolean immediate) Publish an event.
void	release() Release deferred events.
void	subscribe(UpdateEventSubscriber subscriber, DBObjectType type, boolean priority) Add a subscriber to event for a given database object type.
void	unsubscribe(UpdateEventSubscriber subscriber) Remove a subscriber.
void	unsubscribeAll() Remove all subscribers.

Method Detail

subscribe

void subscribe(UpdateEventSubscriber subscriber,
               DBObjectType type,
               boolean priority)

Add a subscriber to event for a given database object type. Priority subscribers are notified before non-priority subscribers. It is the client's responsibility to decide when a priority subscription is warranted.

Parameters:

subscriber - an update event subscriber

type - the database object type subscribed to

priority - if true, handle as a priority subscription

unsubscribe

void unsubscribe(UpdateEventSubscriber subscriber)

Remove a subscriber.

Parameters:

subscriber - an update event subscriber

unsubscribeAll

void unsubscribeAll()

Remove all subscribers.

publish

void publish(UpdateEvent event,
             boolean immediate)

Publish an event. Subscribers are either notified immediately or at a later time when the release() method is invoked.

Parameters:

event - an update event

immediate - if true notify subscribers immediately

release

void release()

Release deferred events.