class Event in Tinman.Core.Util

The Event class implements the observer pattern.

class	Event	extends	Disposable
		implements	IEvent
			IEventListener
		base of	EventGeneric

Public / Attributes

LifecycleState

Returns the lifecycle state of this object.

public virtual property	LifecycleState { get }
type	LifecycleState
value		The lifecycle state.
inherited	Disposable.LifecycleState

Public / Methods

AcquireTry

Acquires a strong reference to this disposable object.

[OwnerReturn, ThreadSafe]
public method	AcquireTry ()
type	IDisposable
returns			this if a new strong reference has been acquired, null if this object is already being disposed.
inherited	Disposable.AcquireTry

Remarks:

The object will not be actually disposed by calls to Dispose when there is at least one strong reference left. Code that calls the AcquireTry method is responsible for calling the Dispose method accordingly.

This method is not intended to be used in performance-critical code. It should only be used to high-level resource management.

AddDelegate

Adds a new listener to this event.

[ThreadSafe]
public method	AddDelegate (EventDelegate listener)
params	listener	[not-null]	The listener to add.
implements	IEvent.AddDelegate

Remarks:

If a listener object is added more than once to an event, it will be notified only once. However, the remove method must be called once for each call to the add method in order to actually remove the listener.

AddListener

Adds a new listener to this event.

[ThreadSafe]
public method	AddListener (IEventListener listener)
params	listener	[not-null]	The listener to add.
implements	IEvent.AddListener

Remarks:

If a listener object is added more than once to an event, it will be notified only once. However, the remove method must be called once for each call to the add method in order to actually remove the listener.

Clear

Removes all listeners from this event.

[ThreadSafe]
public method	Clear ()

Dispose

Releases all resources held by this object if there are no more strong references to it, decrements the reference counter by one otherwise.

[Dispose, OwnerThis, ThreadSafe]
public method	Dispose ()
inherited	Disposable.Dispose

Remarks:

The Dispose method silently returns if the object has already been disposed.

NotifyEvent

The event has been triggered.

public method	NotifyEvent (object argument)
params	argument		The event argument.
implements	IEventListener.NotifyEvent

RemoveDelegate

Removes the given listener from the event.

[ThreadSafe]
public method	RemoveDelegate (EventDelegate listener)
params	listener	[not-null]	The listener to remove.
implements	IEvent.RemoveDelegate

RemoveListener

Removes the given listener from the event.

[ThreadSafe]
public method	RemoveListener (IEventListener listener)
params	listener	[not-null]	The listener to remove.
implements	IEvent.RemoveListener

Protected / Methods

DisposeManaged

Disposes the managed resources held by a concrete subclass. This method will be called at most once per subclass.

protected override method	DisposeManaged ()
overrides	Disposable.DisposeManaged

Remarks:

This method will only be called when a disposable object is explicitly destroyed by user code calling the Dispose method. It will not be called when the object is collected as garbage by the system.

Overriding methods must call the DisposeManaged method of their base class. The base call should be the last statement.

The DisposeManaged method is called before the DisposeUnmanaged method.

DisposeUnmanaged

Disposes the unmanaged resources held by a concrete subclass. This method will be called exactly once per subclass.

protected virtual method	DisposeUnmanaged ()
inherited	Disposable.DisposeUnmanaged

Remarks:

Overriding methods must call the DisposeUnmanaged method of their base class. The base call should be the last statement.

The DisposeUnmanaged method is called after the DisposeManaged method.

DoClear

Removes all registered listeners.

protected virtual method

DoClear ()

DoSnapshot

Creates the snapshot object that captures the registered listeners.

protected virtual method	DoSnapshot ()
type	IEventListener
returns			The snapshot object.