Simias::Client::Event::IProcEventListener Class Reference

Implements the parsing of event listener message to and from its serialized representation. More...

List of all members.

Public Member Functions
	IProcEventListener ()
	Initializes an instance of the object.
	IProcEventListener (XmlDocument document)
	Initializes an instance of the object.
void	AddEvent (IProcEventAction type)
	Adds the specified event to the registration.
void	AddFilter (IProcEventFilter filter)
	Adds the specified filter to the registration.
IEnumerator	GetEventEnumerator ()
	Method used by clients to enumerate the events in the IProcEventListener object.
IEnumerator	GetFilterEnumerator ()
	Method used by clients to enumerate the filters in the IProcEventListener object.
byte[]	ToBuffer ()
	Converts an IProcEventRegistration object to a buffer representation.
override string	ToString ()
	Converts an IProcEventListener object to a string representation.
Static Public Member Functions
static bool	IsValidRequest (XmlDocument document)
	Returns whether document is a listen for event request.

---

Detailed Description

Implements the parsing of event listener message to and from its serialized representation.

---

Constructor & Destructor Documentation

Simias::Client::Event::IProcEventListener::IProcEventListener

(

)

[inline]

Initializes an instance of the object.

Simias::Client::Event::IProcEventListener::IProcEventListener

(

XmlDocument

document

)

[inline]

Initializes an instance of the object.

Parameters:

document

Xml document that describes an IProcEventListener message.

---

Member Function Documentation

void Simias::Client::Event::IProcEventListener::AddEvent

(

IProcEventAction

type

)

[inline]

Adds the specified event to the registration.

Parameters:

type

IProcEventAction to add.

void Simias::Client::Event::IProcEventListener::AddFilter

(

IProcEventFilter

filter

)

[inline]

Adds the specified filter to the registration.

Parameters:

filter

Filter to add.

IEnumerator Simias::Client::Event::IProcEventListener::GetEventEnumerator

(

)

[inline]

Method used by clients to enumerate the events in the IProcEventListener object.

Returns:

An IEnumerator object that can be used to get a list of EventTypes.

IEnumerator Simias::Client::Event::IProcEventListener::GetFilterEnumerator

(

)

[inline]

Method used by clients to enumerate the filters in the IProcEventListener object.

Returns:

An IEnumerator object that can be used to get a list of IProcEventFilter objects.

static bool Simias::Client::Event::IProcEventListener::IsValidRequest

(

XmlDocument

document

)

[inline, static]

Returns whether document is a listen for event request.

Parameters:

document

Xml document to check type for.

Returns:

true if document is a listen for event request document, otherwise false is returned.

byte [] Simias::Client::Event::IProcEventListener::ToBuffer

(

)

[inline]

Converts an IProcEventRegistration object to a buffer representation.

Returns:

A byte array that represents the IProcEventRegistration object.

override string Simias::Client::Event::IProcEventListener::ToString

(

)

[inline]

Converts an IProcEventListener object to a string representation.

Returns:

A string that represents the IProcEventListener object.

---

The documentation for this class was generated from the following file:

• src/core/SimiasClient/IProcEventListener.cs