Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | Related Pages | Search for 

GNUMessenger::NetConf Class Reference

ingroup xml NetConf is a network configuration class that wraps an XML data structure More...

#include <netconf.h>

Inheritance diagram for GNUMessenger::NetConf:

Inheritance graph
[legend]
Collaboration diagram for GNUMessenger::NetConf:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 NetConf ()
 Default constructor.
 NetConf (const NetConf &net)
 Copy constructor.
 NetConf (const XMLNode &node)
 Construct from XMLNode.
string getProtocol ()
 Return the protocol name.
NetConf & setProtocol (const string &name)
 Sets the name of the protocol.
string getServer ()
 Returns the name of the server used for communication.
NetConf & setServer (const string &name)
 Sets the servers FQHN.
virtual const string type () const
virtual const string & name () const
 a virtual function to return a 'name'
virtual XMLNode & setName (const string &name)
 Set tag name.
string getLoginServer ()
 Returns the name of the server used to authenticate.
NetConf & setLoginServer (const string &name)
NetConf & setServerPort (unsigned int port)
unsigned int getServerPort ()
NetConf & setLoginPort (unsigned int port)
unsigned int getLoginPort ()
NetConf & setLogin (const string &name)
string getLogin () const
NetConf & setPassword (const VBuffer &pass)
VBuffer getPassword () const

Detailed Description

ingroup xml NetConf is a network configuration class that wraps an XML data structure

Author:
Jesse Lovelace

Definition at line 38 of file netconf.h.

Constructor & Destructor Documentation

GNUMessenger::NetConf::NetConf (  const NetConf &  net  ) 
 

Copy constructor.

Parameters:
net A NetConf object to copy (shallow).
Definition at line 37 of file netconf.cpp.
00038 : XMLNode(net) 
00039 {}

GNUMessenger::NetConf::NetConf (  const XMLNode &  node  ) 
 

Construct from XMLNode.

Parameters:
node The XMLNode to create object from.
Definition at line 42 of file netconf.cpp.
00043 : XMLNode(node) 
00044 {}

Member Function Documentation

string GNUMessenger::NetConf::getLoginServer (   ) 
 

Returns the name of the server used to authenticate.

Returns:
The FQHN of the login server
Note:
Not all protocols have seperate servers for authentication.
Definition at line 69 of file netconf.cpp.

References GNUMessenger::XMLNode::child(), and GNUMessenger::XMLNode::property().

00070 { 
00071     return child("loginserver").property("host"); 
00072 }

Here is the call graph for this function:

string GNUMessenger::NetConf::getProtocol (   ) 
 

Return the protocol name.

Returns:
A std::string of the protocol name.
Definition at line 46 of file netconf.cpp.

References name().

00047 { 
00048     return name(); 
00049 }

Here is the call graph for this function:

string GNUMessenger::NetConf::getServer (   ) 
 

Returns the name of the server used for communication.

Returns:
std:string of the server name
Definition at line 57 of file netconf.cpp.

References GNUMessenger::XMLNode::child(), and GNUMessenger::XMLNode::property().

00058 { 
00059     return child("server").property("host"); 
00060 }

Here is the call graph for this function:

NetConf & GNUMessenger::NetConf::setProtocol (  const string &  name  ) 
 

Sets the name of the protocol.

Parameters:
name The std:string name of the new protocol
Definition at line 51 of file netconf.cpp.

References setName().

00052 { 
00053     setName(name); 
00054     return *this; 
00055 }

Here is the call graph for this function:

NetConf & GNUMessenger::NetConf::setServer (  const string &  name  ) 
 

Sets the servers FQHN.

Parameters:
The FQHN of the server.
Definition at line 62 of file netconf.cpp.

References GNUMessenger::XMLNode::child(), and GNUMessenger::XMLNode::setProperty().

00063 { 
00064     child("server").setProperty("host", name); 
00065     return *this; 
00066 }

Here is the call graph for this function:

The documentation for this class was generated from the following files:
Generated on Tue Oct 5 14:41:56 2004 for GNU Messenger by doxygen 1.3.8