diff options
Diffstat (limited to 'upnpcomponents/contentdirectory.h')
-rw-r--r-- | upnpcomponents/contentdirectory.h | 20 |
1 files changed, 19 insertions, 1 deletions
diff --git a/upnpcomponents/contentdirectory.h b/upnpcomponents/contentdirectory.h index a504fdc..7fb4bb9 100644 --- a/upnpcomponents/contentdirectory.h +++ b/upnpcomponents/contentdirectory.h @@ -12,12 +12,30 @@ #include "upnpservice.h" #include "../database/metadata.h" +/** + * The content directory service + * + * This is the content directory service which handles all incoming requests + * for contents managed by the media server. + */ class cContentDirectory : public cUpnpService, public cThread { public: - cContentDirectory(UpnpDevice_Handle DeviceHandle, cMediaDatabase* MediaDatabase); + /** + * Constructor of a Content Directory + * + * This creates an instance of a <em>Content Directory Service</em> and provides + * interfaces for executing actions and subscribing on events. + */ + cContentDirectory( + UpnpDevice_Handle DeviceHandle, ///< The UPnP device handle of the root device + cMediaDatabase* MediaDatabase ///< the media database where requests are processed + ); virtual ~cContentDirectory(); + /*! @copydoc cUpnpService::subscribe(Upnp_Subscription_Request* Request) */ virtual int subscribe(Upnp_Subscription_Request* Request); + /*! @copydoc cUpnpService::execute(Upnp_Action_Request* Request) */ virtual int execute(Upnp_Action_Request* Request); + /*! @copydoc cUpnpService::setError(Upnp_Action_Request* Request, int Error) */ virtual void setError(Upnp_Action_Request* Request, int Error); private: cMediaDatabase* mMediaDatabase; |