Simias::Client::Event::IProcEventRegistration Class Reference

Implements the parsing of event registration data to and from is serialized representation. More...

List of all members.

Public Member Functions
	IProcEventRegistration (IPEndPoint endPoint, bool registering)
	Initializes an instance of the object.
	IProcEventRegistration (XmlDocument document)
	Initializes an instance of the object.
byte[]	ToBuffer ()
	Converts an IProcEventRegistration object to a buffer representation.
override string	ToString ()
	Converts an IProcEventRegistration object to a string representation.
Static Public Member Functions
static bool	IsValidRequest (XmlDocument document)
	Returns whether document is a registration form request.
Properties
IPAddress	RemoteAddress [get]
	Gets the remote address from the registration message.
int	Port [get]
	Gets the remote port number from the registration message.
bool	Registering [get]
	Gets whether the client is registering.

---

Detailed Description

Implements the parsing of event registration data to and from is serialized representation.

---

Constructor & Destructor Documentation

Simias::Client::Event::IProcEventRegistration::IProcEventRegistration	(	IPEndPoint	endPoint,
		bool	registering
	)			[inline]

Initializes an instance of the object.

Parameters:

	endPoint	End point that will listen for subscribed events.
	registering	true if client is registering otherwise false is set.

Simias::Client::Event::IProcEventRegistration::IProcEventRegistration

(

XmlDocument

document

)

[inline]

Initializes an instance of the object.

Parameters:

document

An event registration request document.

---

Member Function Documentation

static bool Simias::Client::Event::IProcEventRegistration::IsValidRequest

(

XmlDocument

document

)

[inline, static]

Returns whether document is a registration form request.

Parameters:

document

Xml document to check type for.

Returns:

true if document is a registration document, otherwise false is returned.

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

(

)

[inline]

Converts an IProcEventRegistration object to a buffer representation.

Returns:

A byte array that represents the IProcEventRegistration object.

override string Simias::Client::Event::IProcEventRegistration::ToString

(

)

[inline]

Converts an IProcEventRegistration object to a string representation.

Returns:

A string that represents the IProcEventRegistration object.

---

Property Documentation

IPAddress Simias::Client::Event::IProcEventRegistration::RemoteAddress [get]

Gets the remote address from the registration message.

int Simias::Client::Event::IProcEventRegistration::Port [get]

Gets the remote port number from the registration message.

bool Simias::Client::Event::IProcEventRegistration::Registering [get]

Gets whether the client is registering.

---

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

• src/core/SimiasClient/IProcEventRegistration.cs