#include <jid.h>
Detailed Description
An abstraction of a JID.
- Author
- Jakob Schroeter js@ca.nosp@m.maya.nosp@m..net
- Since
- 0.4
Definition at line 30 of file jid.h.
Constructor & Destructor Documentation
Constructs an empty JID.
Definition at line 37 of file jid.h.
JID |
( |
const std::string & |
jid | ) |
|
|
inline |
Constructs a new JID from a string.
- Parameters
-
jid | The string containing the JID. |
Definition at line 43 of file jid.h.
Destructor.
Definition at line 48 of file jid.h.
Member Function Documentation
const std::string& bare |
( |
| ) |
const |
|
inline |
Returns the bare (prepped) JID (user@host).
- Returns
- The bare JID.
Definition at line 66 of file jid.h.
Creates and returns a JID from this JID's node and server parts.
- Returns
- The bare JID.
- Since
- 0.9
Definition at line 73 of file jid.h.
GLOOX_DEPRECATED bool empty |
( |
| ) |
const |
|
inline |
A JID is empty as long as no server is set.
- Returns
- True if the JID is empty, false otherwise.
- Deprecated:
- Use operator bool() instead
Definition at line 130 of file jid.h.
const std::string& full |
( |
| ) |
const |
|
inline |
Returns the full (prepped) JID (user@host/resource).
- Returns
- The full JID.
Definition at line 60 of file jid.h.
GLOOX_DEPRECATED JID fullJID |
( |
| ) |
const |
|
inline |
Creates and returns a JID from this JID's node, server and resource parts.
- Returns
- The full JID.
- Since
- 0.9
- Deprecated:
Definition at line 81 of file jid.h.
Returns true if the Tag is valid, false otherwise.
Definition at line 147 of file jid.h.
bool operator!= |
( |
const JID & |
right | ) |
const |
|
inline |
Compares two JIDs.
- Parameters
-
Definition at line 142 of file jid.h.
bool operator== |
( |
const JID & |
right | ) |
const |
|
inline |
Compares two JIDs.
- Parameters
-
Definition at line 136 of file jid.h.
const std::string& resource |
( |
| ) |
const |
|
inline |
Returns the prepped resource.
- Returns
- The current resource.
Definition at line 123 of file jid.h.
const std::string& server |
( |
| ) |
const |
|
inline |
Returns the prepped server name.
- Returns
- The current server.
Definition at line 111 of file jid.h.
const std::string& serverRaw |
( |
| ) |
const |
|
inline |
Returns the raw (unprepped) server name.
- Returns
- The raw server name.
Definition at line 117 of file jid.h.
void setJID |
( |
const std::string & |
jid | ) |
|
Sets the JID from a string.
- Parameters
-
jid | The string containing the JID. |
Definition at line 21 of file jid.cpp.
void setResource |
( |
const std::string & |
resource | ) |
|
Sets the resource.
- Parameters
-
resource | The new resource. |
Definition at line 74 of file jid.cpp.
void setServer |
( |
const std::string & |
server | ) |
|
Sets the server.
- Parameters
-
Definition at line 67 of file jid.cpp.
void setUsername |
( |
const std::string & |
username | ) |
|
Sets the username.
- Parameters
-
username | The new username. |
Definition at line 61 of file jid.cpp.
const std::string& username |
( |
| ) |
const |
|
inline |
Returns the prepped username.
- Returns
- The current username.
Definition at line 105 of file jid.h.
The documentation for this class was generated from the following files: