com.neeve.emx
Class IEmxDispatcher.Params

java.lang.Object
  com.neeve.emx.IEmxDispatcher.Params

All Implemented Interfaces:

Cloneable

Enclosing interface:

IEmxDispatcher

public static class IEmxDispatcher.Params
extends Object
implements Cloneable

Specifies dispatcher operating parameters.

This class is used to specify the operating parameters of a dispatcher. An instance of this class is provided to the dispatcher during creation.

Threading:

This class is safe for concurrent access by multiple threads.

Method Summary

Object	clone() Clone the parameters object
static IEmxDispatcher.Params	create() Create a default parameters object
static IEmxDispatcher.Params	create(boolean timestampEvents, boolean threaded) Create a parameters object using specified parameters.
boolean	equals(IEmxDispatcher.Params params) Indicates whether another parameter object equals this one.
boolean	getThreaded() Get the 'threaded' parameter value.
boolean	getTimestampEvents() Get the 'timestamp events' parameter value.
String	toString() Get a string representation of the parameter object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

create

public static IEmxDispatcher.Params create(boolean timestampEvents,
                                           boolean threaded)

Create a parameters object using specified parameters.

Parameters:

timestampEvents - Specifies whether events scheduled with the dispatcher should be stamped with the event schedule and dispatch time. A value of false on this parameter will cause the IEmxEvent.getLatency() method to always return 0.

threaded - Specifies whether the dispatcher is to operate in a multi-threaded mode i.e. whether a thread different from the dispatcher owner can schedule user events with the dispatcher.

Returns:

Returns the created parameters object

Threading:

This method is safe for concurrent access by multiple threads.

create

public static IEmxDispatcher.Params create()

Create a default parameters object

Returns:

Returns the created parameters object

Threading:

This method is safe for concurrent access by multiple threads.

getThreaded

public final boolean getThreaded()

Get the 'threaded' parameter value.

Returns:

Returns the threaded parameter value.

Threading:

This method is safe for concurrent access by multiple threads.

getTimestampEvents

public final boolean getTimestampEvents()

Get the 'timestamp events' parameter value.

Returns:

Returns the 'timestamp events' parameter value.

Threading:

This method is safe for concurrent access by multiple threads.

clone

public Object clone()

Clone the parameters object

Overrides:

clone in class Object

Threading:

This method is safe for concurrent access by multiple threads.

This method creates a clone of the parameters object

equals

public boolean equals(IEmxDispatcher.Params params)

Indicates whether another parameter object equals this one.

Threading:

This method is safe for concurrent access by multiple threads.

toString

public String toString()

Get a string representation of the parameter object.

Overrides:

toString in class Object

Threading:

This method is safe for concurrent access by multiple threads.