cContentDirectory Class Reference

#include <contentdirectory.h>

Inheritance diagram for cContentDirectory:

Collaboration diagram for cContentDirectory:

List of all members.

Public Member Functions

cContentDirectory (UpnpDevice_Handle DeviceHandle, cMediaDatabase *MediaDatabase)

virtual int subscribe (Upnp_Subscription_Request *Request)

virtual int execute (Upnp_Action_Request *Request)

virtual void setError (Upnp_Action_Request *Request, int Error)

Detailed Description

The content directory service

This is the content directory service which handles all incoming requests for contents managed by the media server.

Constructor & Destructor Documentation

cContentDirectory::cContentDirectory	(	UpnpDevice_Handle	DeviceHandle,
		cMediaDatabase *	MediaDatabase
	)

Constructor of a Content Directory

This creates an instance of a Content Directory Service and provides interfaces for executing actions and subscribing on events.

Parameters:

	DeviceHandle	The UPnP device handle of the root device
	MediaDatabase	the media database where requests are processed

Member Function Documentation

int cContentDirectory::execute ( Upnp_Action_Request * Request ) [virtual]

Executes an action

This executes an action initialized by a control point. The result is stored in the first parameter.

Returns:

An integer representing one of the following:

UPNP_E_SUCCESS, if subscription was okay
or any other non null value in case of an error

Parameters:

Request

Input and output parameters of an action

Implements cUpnpService.

void cContentDirectory::setError	(	Upnp_Action_Request *	Request,
		int	Error
	)			`[virtual]`

Sets an error on an action request

This function puts a error message into the action request structure according to its error code

Parameters:

	Request	the action request, to set the error for
	Error	the error code of which the message should be obtained

Reimplemented from cUpnpService.

int cContentDirectory::subscribe ( Upnp_Subscription_Request * Request ) [virtual]

Subscribes to an event

This is a callback function to register a new subscriber for an event.

Returns:

An integer representing one of the following:

UPNP_E_SUCCESS, if subscription was okay
or any other non null value in case of an error

Parameters:

Request

Information about the subscription

Implements cUpnpService.

The documentation for this class was generated from the following files:

upnpcomponents/contentdirectory.h
upnpcomponents/contentdirectory.cpp


Public Member Functions
	cContentDirectory (UpnpDevice_Handle DeviceHandle, cMediaDatabase *MediaDatabase)
virtual int	subscribe (Upnp_Subscription_Request *Request)
virtual int	execute (Upnp_Action_Request *Request)
virtual void	setError (Upnp_Action_Request *Request, int Error)