diff options
Diffstat (limited to 'Swiften/Disco/ClientDiscoManager.h')
-rw-r--r-- | Swiften/Disco/ClientDiscoManager.h | 115 |
1 files changed, 58 insertions, 57 deletions
diff --git a/Swiften/Disco/ClientDiscoManager.h b/Swiften/Disco/ClientDiscoManager.h index 560c69a..595beeb 100644 --- a/Swiften/Disco/ClientDiscoManager.h +++ b/Swiften/Disco/ClientDiscoManager.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2010-2013 Isode Limited. + * Copyright (c) 2010-2016 Isode Limited. * All rights reserved. * See the COPYING file for more information. */ @@ -12,66 +12,67 @@ #include <Swiften/Presence/PayloadAddingPresenceSender.h> namespace Swift { - class IQRouter; - class DiscoInfoResponder; - class PayloadAddingPresenceSender; - class PresenceSender; - class CryptoProvider; + class IQRouter; + class DiscoInfoResponder; + class PayloadAddingPresenceSender; + class PresenceSender; + class CryptoProvider; - /** - * Class responsible for managing outgoing disco information for a client. - * - * The manager will respond to disco#info requests, and add entity capabilities information - * to outgoing presence. - * - * To use this class, call setCapsNode() once with the caps URI of the client. After this, - * call setDiscoInfo() with the capabilities for the client. This can be - * called whenever the capabilities change. - */ - class SWIFTEN_API ClientDiscoManager { - public: - /** - * Constructs the manager - * - * \param iqRouter the router on which requests will be answered - * \param presenceSender the presence sender to which all outgoing presence - * (with caps information) will be sent. - */ - ClientDiscoManager(IQRouter* iqRouter, PresenceSender* presenceSender, CryptoProvider* crypto); - ~ClientDiscoManager(); + /** + * Class responsible for managing outgoing disco information for a client. + * + * The manager will respond to disco#info requests, and add entity capabilities information + * to outgoing presence. + * + * To use this class, call setCapsNode() once with the caps URI of the client. After this, + * call setDiscoInfo() with the capabilities for the client. This can be + * called whenever the capabilities change. + */ + class SWIFTEN_API ClientDiscoManager { + public: + /** + * Constructs the manager + * + * \param iqRouter the router on which requests will be answered + * \param presenceSender the presence sender to which all outgoing presence + * (with caps information) will be sent. + * \param crypto the crypto provider used for cryptographic hash computations. + */ + ClientDiscoManager(IQRouter* iqRouter, PresenceSender* presenceSender, CryptoProvider* crypto); + ~ClientDiscoManager(); - /** - * Needs to be called before calling setDiscoInfo(). - */ - void setCapsNode(const std::string& node); + /** + * Needs to be called before calling setDiscoInfo(). + */ + void setCapsNode(const std::string& node); - /** - * Sets the capabilities of the client. - */ - void setDiscoInfo(const DiscoInfo& info); + /** + * Sets the capabilities of the client. + */ + void setDiscoInfo(const DiscoInfo& info); - /** - * Returns the presence sender through which all outgoing presence - * should be sent. - * The manager will add the necessary caps information, and forward it to - * the presence sender passed at construction time. - */ - PresenceSender* getPresenceSender() const { - return presenceSender; - } + /** + * Returns the presence sender through which all outgoing presence + * should be sent. + * The manager will add the necessary caps information, and forward it to + * the presence sender passed at construction time. + */ + PresenceSender* getPresenceSender() const { + return presenceSender; + } - /** - * Called when the client is connected. - * This resets the presence sender, such that it assumes initial presence - * hasn't been sent yet. - */ - void handleConnected(); + /** + * Called when the client is connected. + * This resets the presence sender, such that it assumes initial presence + * hasn't been sent yet. + */ + void handleConnected(); - private: - PayloadAddingPresenceSender* presenceSender; - CryptoProvider* crypto; - DiscoInfoResponder* discoInfoResponder; - std::string capsNode; - CapsInfo::ref capsInfo; - }; + private: + PayloadAddingPresenceSender* presenceSender; + CryptoProvider* crypto; + DiscoInfoResponder* discoInfoResponder; + std::string capsNode; + CapsInfo::ref capsInfo; + }; } |