org.ow2.util.event.api
Interface IEventDispatcher

public interface IEventDispatcher

Define methods needed to register listeners and dispatch events.

Author:

missonng

Method Summary

void	addListener(IEventListener listener) Add an event listener.
IEventToken	dispatch(IEvent event) Dispatch this event.
IEventToken	dispatch(IEvent event, EventPriority priority) Dispatch an event.
IEventToken	dispatch(IEvent event, EventPriority priority, int nbWorker) Dispatch an event.
IEventToken	dispatch(IEvent event, EventPriority priority, long timeout) Dispatch an event.
IEventToken	dispatch(IEvent event, EventPriority priority, long timeout, int nbWorker) Dispatch an event.
IEventToken	dispatch(IEvent event, int nbWorker) Dispatch an event.
IEventToken	dispatch(IEvent event, long timeout) Dispatch an event.
IEventToken	dispatch(IEvent event, long timeout, int nbWorker) Dispatch an event.
int	getNbWorkers() Get the number of workers.
void	removeListener(IEventListener listener) Remove an event listener.
void	setNbWorkers(int nbWorkers) Set the number of workers.
void	start() Start the dispatcher.
void	stop() Stop the dispatcher.

Method Detail

start

void start()

Start the dispatcher.

stop

void stop()

Stop the dispatcher.

getNbWorkers

int getNbWorkers()

Get the number of workers.

Returns:

The number of workers.

setNbWorkers

void setNbWorkers(int nbWorkers)

Set the number of workers.

Parameters:

nbWorkers - The number of workers.

addListener

void addListener(IEventListener listener)

Add an event listener.

Parameters:

listener - The event listener to add.

removeListener

void removeListener(IEventListener listener)

Remove an event listener.

Parameters:

listener - The event listener to remove.

dispatch

IEventToken dispatch(IEvent event)

Dispatch this event.

Parameters:

event - The event to dispatch.

Returns:

A token to manage the event processing, or null if the dispatcher is not available.

dispatch

IEventToken dispatch(IEvent event,
                     EventPriority priority)

Dispatch an event.

Parameters:

event - The event to dispatch.

priority - the priority to synchronize with, or null to get the token immediately.

Returns:

A token to manage the event processing, or null if the dispatcher is not available.

dispatch

IEventToken dispatch(IEvent event,
                     long timeout)

Dispatch an event.

Parameters:

event - The event to dispatch.

timeout - The maximum time dispatch waits for synchronous listeners to process.

Returns:

A token to manage the event processing, or null if the dispatcher is not available.

dispatch

IEventToken dispatch(IEvent event,
                     int nbWorker)

Dispatch an event.

Parameters:

event - The event to dispatch.

nbWorker - The number of worker to allocate.

Returns:

A token to manage the event processing, or null if the dispatcher is not available.

dispatch

IEventToken dispatch(IEvent event,
                     EventPriority priority,
                     long timeout)

Dispatch an event.

Parameters:

event - The event to dispatch.

priority - the priority to synchronize with, or null to get the token immediately.

timeout - The maximum time dispatch waits for synchronous listeners to process.

Returns:

A token to manage the event processing, or null if the dispatcher is not available.

dispatch

IEventToken dispatch(IEvent event,
                     EventPriority priority,
                     int nbWorker)

Dispatch an event.

Parameters:

event - The event to dispatch.

priority - the priority to synchronize with, or null to get the token immediately.

nbWorker - The number of worker to allocate.

Returns:

A token to manage the event processing, or null if the dispatcher is not available.

dispatch

IEventToken dispatch(IEvent event,
                     long timeout,
                     int nbWorker)

Dispatch an event.

Parameters:

event - The event to dispatch.

timeout - The maximum time dispatch waits for synchronous listeners to process.

nbWorker - The number of worker to allocate.

Returns:

A token to manage the event processing, or null if the dispatcher is not available.

dispatch

IEventToken dispatch(IEvent event,
                     EventPriority priority,
                     long timeout,
                     int nbWorker)

Dispatch an event.

Parameters:

event - The event to dispatch.

priority - the priority to synchronize with, or null to get the token immediately.

timeout - The maximum time dispatch waits for synchronous listeners to process.

nbWorker - The number of worker to allocate.

Returns:

A token to manage the event processing, or null if the dispatcher is not available.