This class represents a nirvana Realm. More...
#include <nRealm.h>
Public Member Functions | |||
| std::list< std::string > * | getConnections () | ||
| Gets the collection of the network interfaces this realm listens in. More... | |||
| const std::string | getMountPoint () | ||
| Returns the relative name of the realm within the namespace. More... | |||
| std::string | getName () | ||
| Gets the name of this realm. More... | |||
| std::string * | getProtocols (int &nString) | ||
| Returns an array of Strings with the rnames for this realm. More... | |||
| nRealm (void) | |||
Constructs a new nRealm object
| |||
| nRealm (std::string name, std::string *pConnections, int nConnection) | |||
| Constructs a new nRealm object with the specified name and collection of network interfaces. More... | |||
| nRealm (std::string name, std::list< fConnectionDetails * > connections) | |||
| Constructs a new nRealm object with the specified name and collection of network interfaces. More... | |||
| void | setMountPoint (const std::string &mountPoint) | ||
| Sets the relative name for the realm within the namespace. More... | |||
| void | setName (std::string data) | ||
| Sets the name on this realm. More... | |||
This class represents a nirvana Realm.
| com::pcbsys::nirvana::client::nRealm::nRealm | ( | std::string | name, |
| std::string * | pConnections, | ||
| int | nConnection | ||
| ) |
Constructs a new nRealm object with the specified name and collection of network interfaces.
| name | A string specifying the realm's name |
| pConnections | An array of strings specifying the realm's network interfaces. |
| nConnection | length of the pConnections array These have to be in the form: protocol://host:port/servlet File , where: |
Protocol can be one of nsp, nhp, nsps, nhps where:
nsp => Nirvana Socket Protocol nhp => Nirvana HTTP Protocol nsps => Nirvana Socket Protocol Secure (Socket protocol over SSL/TLS) nhps => Nirvana HTTP Protocol Secure (HTTP protocol over SSL/TLS)
Host is the host the realm is running on
Port is the port the realm is listening on
servlet File specifies the location that servlets are mapped if talking to the realm via a web server (e.g. in a DMZ environment)
| nIllegalArgumentException | if the parameters are invalid, refer to the exception message for more information |
| com::pcbsys::nirvana::client::nRealm::nRealm | ( | std::string | name, |
| std::list< fConnectionDetails * > | connections | ||
| ) |
Constructs a new nRealm object with the specified name and collection of network interfaces.
| name | A string specifying the realm's name |
| connections | A list of fConnectionDetails objects. These are created using strings specifying the realm's network interfaces. The strings have to be in the form: protocol://host:port/servlet File , where: Protocol can be one of nsp, nhp, nsps, nhps where: |
nsp => Nirvana Socket Protocol nhp => Nirvana HTTP Protocol nsps => Nirvana Socket Protocol Secure (Socket protocol over SSL/TLS) nhps => Nirvana HTTP Protocol Secure (HTTP protocol over SSL/TLS)
Host is the host the realm is running on
Port is the port the realm is listening on
servlet File specifies the location that servlets are mapped if talking to the realm via a web server (e.g. in a DMZ environment)
| nIllegalArgumentException | if the parameters are invalid, refer to the exception message for more information |
| std::list<std::string>* com::pcbsys::nirvana::client::nRealm::getConnections | ( | ) |
Gets the collection of the network interfaces this realm listens in.
| const std::string com::pcbsys::nirvana::client::nRealm::getMountPoint | ( | ) |
Returns the relative name of the realm within the namespace.
| std::string com::pcbsys::nirvana::client::nRealm::getName | ( | ) |
Gets the name of this realm.
| std::string* com::pcbsys::nirvana::client::nRealm::getProtocols | ( | int & | nString | ) |
Returns an array of Strings with the rnames for this realm.
| void com::pcbsys::nirvana::client::nRealm::setMountPoint | ( | const std::string & | mountPoint | ) |
Sets the relative name for the realm within the namespace.
| mountPoint | the name to add this realm in the namespace |
| nIllegalArgumentException | Illegal parameter, check the message for more information |
| void com::pcbsys::nirvana::client::nRealm::setName | ( | std::string | data | ) |
Sets the name on this realm.
| data | a string specifying the name of this realm |
| nIllegalArgumentException | Illegal parameter, check the message for more information |