Swiftdiff options
| author | Kevin Smith <git@kismith.co.uk> | 2011-06-29 17:03:59 (GMT) |
|---|---|---|
| committer | Kevin Smith <git@kismith.co.uk> | 2011-06-29 17:03:59 (GMT) |
| commit | 07c7c86ad6d6397e3befb3ac9fc92dd16a6bcdfe (patch) | |
| tree | 362a89e3e2723f89592dab3da93ed05d0af01644 | |
| parent | 0eeb4f028cc9fc1006cc767d93509383b7f33ad8 (diff) | |
| download | swift-07c7c86ad6d6397e3befb3ac9fc92dd16a6bcdfe.zip swift-07c7c86ad6d6397e3befb3ac9fc92dd16a6bcdfe.tar.bz2 | |
JID doxygen
| -rw-r--r-- | Swiften/JID/JID.h | 71 |
1 files changed, 70 insertions, 1 deletions
diff --git a/Swiften/JID/JID.h b/Swiften/JID/JID.h index 98b42da..8e3b949 100644 --- a/Swiften/JID/JID.h +++ b/Swiften/JID/JID.h @@ -10,30 +10,95 @@ #include <iosfwd> namespace Swift { + /** + * This represents the JID used in XMPP + * (RFC6120 - http://tools.ietf.org/html/rfc6120 ). + * For a description of format, see the RFC or page 14 of + * XMPP: The Definitive Guide (Saint-Andre et al.) + * + * Particularly - a Bare JID is a JID without a resource part. + * + */ class JID { public: enum CompareType { WithResource, WithoutResource }; - JID(const std::string& = std::string()); + /** + * Create a JID from its String representation. + * + * e.g. + * wonderland.lit + * wonderland.lit/rabbithole + * alice@wonderland.lit + * alice@wonderland.lit/TeaParty + * + * @param jid String representation. Invalid JID if empty or invalid. + */ + JID(const std::string& jid = std::string()); + + /** + * See std::string constructor. + */ JID(const char*); + + /** + * Create a bare JID from the node and domain parts. + * + * JID("node@domain") == JID("node", "domain") + * unless you pass in empty values. + * + * @param node JID node part. + * @param domain JID domain part. + */ JID(const std::string& node, const std::string& domain); + /** + * Create a bare JID from the node, domain and resource parts. + * + * JID("node@domain/resource") == JID("node", "domain", "resource") + * unless you pass in empty values. + * + * @param node JID node part. + * @param domain JID domain part. + * @param resource JID resource part. + */ JID(const std::string& node, const std::string& domain, const std::string& resource); + /** + * @return Is a correctly-formatted JID. + */ bool isValid() const { return !domain_.empty(); /* FIXME */ } + /** + * e.g. JID("node@domain").getNode() == "node" + * @return could be empty. + */ const std::string& getNode() const { return node_; } + + /** + * e.g. JID("node@domain").getDomain() == "domain" + * @return could be empty. + */ const std::string& getDomain() const { return domain_; } + + /** + * e.g. JID("node@domain/resource").getResource() == "resource" + * @return could be empty. + */ const std::string& getResource() const { return resource_; } + + /** + * Is a bare JID, i.e. has no resource part. + */ bool isBare() const { return !hasResource_; } @@ -50,6 +115,10 @@ namespace Swift { */ std::string getUnescapedNode() const; + /** + * Get the JID without a resource. + * @return Invalid if the original is invalid. + */ JID toBare() const { JID result(*this); result.hasResource_ = false; |