BrisaUpnp::BrisaService Class Reference

UPnP service abstraction. More...

#include <BrisaUpnp/BrisaService>

Inheritance diagram for BrisaUpnp::BrisaService:
BrisaUpnp::BrisaAbstractService

List of all members.

Public Slots

void parseGenericRequest (const QString &method, const QMultiHash< QString, QString > &headers, const QByteArray &requestContent, int sessionId, int requestId)

Public Member Functions

 BrisaService (QObject *parent=0)
 BrisaService (const QString &serviceType, const QString &serviceId="", const QString &scpdUrl="", const QString &controlUrl="", const QString &eventSubUrl="", const QString &host="", QObject *parent=0)
 BrisaService (BrisaService &service)
 ~BrisaService ()
BrisaStateVariablegetVariable (const QString &variableName)
BrisaCore::BrisaWebServiceProvidergetWebService ()
void buildWebServiceTree (QxtAbstractWebSessionManager *sessionManager)
void setDescriptionFile (const QString &scpdFilePath)
QString getDescriptionFile ()

Detailed Description

UPnP service abstraction.

BrisaService provides a convinient way to create UPnP services. BrisaService itself contains a webservice, so integration with the webserver is simple. You can simply create your service actions with BrisaAction, then create a new BrisaService with the proper information and simply call addAction() with the previously created actions. The next step is to add your service to the device.

Definition at line 112 of file brisaservice.h.


Constructor & Destructor Documentation

BrisaService::BrisaService ( QObject *  parent = 0  ) 

Constructs a BrisaService with the given parent.

Definition at line 69 of file brisaservice.cpp.

BrisaService::BrisaService ( const QString &  serviceType,
const QString &  serviceId = "",
const QString &  scpdUrl = "",
const QString &  controlUrl = "",
const QString &  eventSubUrl = "",
const QString &  host = "",
QObject *  parent = 0 
)

Constructs a BrisaService with the given service information.

Definition at line 73 of file brisaservice.cpp.

BrisaService::BrisaService ( BrisaService service  ) 

Copy constructor.

Definition at line 81 of file brisaservice.cpp.

BrisaService::~BrisaService (  ) 

Destructor.

Definition at line 85 of file brisaservice.cpp.


Member Function Documentation

void BrisaService::buildWebServiceTree ( QxtAbstractWebSessionManager *  sessionManager  ) 

This method creates all the webservice related stuff. It creates a URL for the control path, another url for the event path, and publishs the service description XML file.

Definition at line 202 of file brisaservice.cpp.

QString BrisaService::getDescriptionFile (  ) 

Returns the service scpd path.

Definition at line 311 of file brisaservice.cpp.

BrisaStateVariable * BrisaService::getVariable ( const QString &  variableName  ) 

Returns the requested BrisaStateVariable, if the variable doesn't exists it return 0.

Definition at line 237 of file brisaservice.cpp.

BrisaWebServiceProvider * BrisaService::getWebService (  ) 

Returns the web service.

Definition at line 247 of file brisaservice.cpp.

void BrisaService::parseGenericRequest ( const QString &  method,
const QMultiHash< QString, QString > &  headers,
const QByteArray &  requestContent,
int  sessionId,
int  requestId 
) [slot]

Parses the genericRequestReceived() signal coming from the webservice.

Definition at line 251 of file brisaservice.cpp.

void BrisaService::setDescriptionFile ( const QString &  scpdFilePath  ) 

Sets the service file path.

Definition at line 307 of file brisaservice.cpp.


The documentation for this class was generated from the following files:
Generated on Thu Sep 30 14:04:30 2010 for Brisa by  doxygen 1.6.3