Simias::Storage::HostNode Class Reference

Class that represents a Simias Host. More...

Inheritance diagram for Simias::Storage::HostNode:

[legend]

Collaboration diagram for Simias::Storage::HostNode:

[legend]

List of all members.

Public Member Functions
	HostNode (string name, string userId, string publicUrl, string privateUrl)
	Construct a new host node.
	HostNode (string name, string userId, string publicUrl, string privateUrl, RSACryptoServiceProvider publicKey)
	Construct a new host node.
	HostNode (string name, string userId, string publicAddress)
	Consturct a new host node.
	HostNode (HostInfo hInfo, string publicAddress)
	HostNode (Node node)
	Construct a host node from a node.
	HostNode (Collection collection, ShallowNode shallowNode)
	Construct a host node from a shallow node.
ICSList	GetHostedMembers ()
	Gets the list of hosted members of a domain.
Static Public Member Functions
static HostNode	FromXml (Store store, XmlDocument document)
	Create a HostNode from the xml document.
static HostNode	GetHostByID (string domainId, string hostId)
	Get HostNode from host ID.
static HostNode	GetHostByName (string domainId, string hostName)
	Get the host from name.
static HostNode[]	GetHosts (string domainId)
	Gets the hosts available in a domain.
static HostNode	GetMaster (string domainId)
	Gets the master in a domain.
static HostNode	GetLocalHost ()
	Gets the local host.
Properties
string	PublicUrl [get, set]
	Gets/Sets the public address for this host.
string	PrivateUrl [get, set]
	Gets/Sets the private address for this host.
bool	IsMasterHost [get, set]
	Gets/Sets if HostNode is the Master Host.
bool	IsLocalHost [get, set]
	Gets/Sets If HostNode is the local host.

---

Detailed Description

Class that represents a Simias Host.

---

Constructor & Destructor Documentation

Simias::Storage::HostNode::HostNode	(	string	name,
		string	userId,
		string	publicUrl,
		string	privateUrl
	)			[inline]

Construct a new host node.

Parameters:

	name	The name of the host.
	userId	Unique identifier for the user.
	publicUrl	The public url for the host.
	privateUrl	The private url for the host.

Simias::Storage::HostNode::HostNode	(	string	name,
		string	userId,
		string	publicUrl,
		string	privateUrl,
		RSACryptoServiceProvider	publicKey
	)			[inline]

Construct a new host node.

Parameters:

	name	The name of the host.
	userId	Unique identifier for the user.
	publicUrl	The public URL for the host.
	privateUrl	The private URL for the host.
	publicKey

Simias::Storage::HostNode::HostNode	(	string	name,
		string	userId,
		string	publicAddress
	)			[inline]

Consturct a new host node.

Parameters:

	name	The name of the host.
	userId	Unique identifier for the user.
	publicAddress	The public address for the host.

Simias::Storage::HostNode::HostNode	(	HostInfo	hInfo,
		string	publicAddress
	)			[inline]

Parameters:

	name
	nodeID
	userId
	publicAddress

Simias::Storage::HostNode::HostNode

(

Node

node

)

[inline]

Construct a host node from a node.

Parameters:

node

The host node.

Simias::Storage::HostNode::HostNode	(	Collection	collection,
		ShallowNode	shallowNode
	)			[inline]

Construct a host node from a shallow node.

Parameters:

	collection	The collection the node belongs to.
	shallowNode	The shallow node that represents the HostNode.

---

Member Function Documentation

static HostNode Simias::Storage::HostNode::FromXml	(	Store	store,
		XmlDocument	document
	)			[inline, static]

Create a HostNode from the xml document.

Parameters:

	store	The store.
	document	The xml document.

Returns:

static HostNode Simias::Storage::HostNode::GetHostByID	(	string	domainId,
		string	hostId
	)			[inline, static]

Get HostNode from host ID.

Parameters:

	domainId	Domain ID where host is available
	hostId	ID of the host whose name we have to get

Returns:

Retuns the Host node

static HostNode Simias::Storage::HostNode::GetHostByName	(	string	domainId,
		string	hostName
	)			[inline, static]

Get the host from name.

Parameters:

	domainId	Domain ID where host is available
	hostName	Name of the host

Returns:

Returns the HostNode

static HostNode [] Simias::Storage::HostNode::GetHosts

(

string

domainId

)

[inline, static]

Gets the hosts available in a domain.

Parameters:

domainId

Domain ID

Returns:

Array of HostNode

static HostNode Simias::Storage::HostNode::GetMaster

(

string

domainId

)

[inline, static]

Gets the master in a domain.

Parameters:

domainId

Domain ID for which master details needed

Returns:

Returns the HostNode of master

ICSList Simias::Storage::HostNode::GetHostedMembers

(

)

[inline]

Gets the list of hosted members of a domain.

Returns:

ICSList with host members

static HostNode Simias::Storage::HostNode::GetLocalHost

(

)

[inline, static]

Gets the local host.

Returns:

Hostnode with local host details

---

Property Documentation

string Simias::Storage::HostNode::PublicUrl [get, set]

Gets/Sets the public address for this host.

string Simias::Storage::HostNode::PrivateUrl [get, set]

Gets/Sets the private address for this host.

bool Simias::Storage::HostNode::IsMasterHost [get, set]

Gets/Sets if HostNode is the Master Host.

bool Simias::Storage::HostNode::IsLocalHost [get, set]

Gets/Sets If HostNode is the local host.

---

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

• src/core/CollectionStore/HostNode.cs