Herqq
|
This class is used to contain information of a UPnP service found in a UPnP device description document. More...
#include <HServiceInfo>
Public Member Functions | |
HServiceInfo () | |
HServiceInfo (const HServiceId &serviceId, const HResourceType &serviceType, const QUrl &controlUrl, const QUrl &eventSubUrl, const QUrl &scpdUrl, HInclusionRequirement incReq=InclusionMandatory, HValidityCheckLevel checkLevel=StrictChecks, QString *err=0) | |
~HServiceInfo () | |
HServiceInfo (const HServiceInfo &other) | |
HServiceInfo & | operator= (const HServiceInfo &other) |
bool | isValid (HValidityCheckLevel level) const |
const HServiceId & | serviceId () const |
const HResourceType & | serviceType () const |
QUrl | scpdUrl () const |
QUrl | controlUrl () const |
QUrl | eventSubUrl () const |
HInclusionRequirement | inclusionRequirement () const |
Friends | |
H_UPNP_CORE_EXPORT bool | operator== (const HServiceInfo &obj1, const HServiceInfo &obj2) |
Related Functions | |
(Note that these are not member functions.) | |
bool | operator!= (const HServiceInfo &obj1, const HServiceInfo &obj2) |
This class is used to contain information of a UPnP service found in a UPnP device description document.
A device description defines a UPnP device and among other things, the definition includes the declarations of the services the device contains. This class contains the service declaration information.
HServiceInfo | ( | ) |
Creates a new, empty instance.
HServiceInfo | ( | const HServiceId & | serviceId, |
const HResourceType & | serviceType, | ||
const QUrl & | controlUrl, | ||
const QUrl & | eventSubUrl, | ||
const QUrl & | scpdUrl, | ||
HInclusionRequirement | incReq = InclusionMandatory , |
||
HValidityCheckLevel | checkLevel = StrictChecks , |
||
QString * | err = 0 |
||
) |
Constructs a new instance from the specified parameters that the UDA specification mandates for a UPnP service.
The parameters the constructor expects are arguments defined in the device description document and they are all mandatory for a valid UPnP service.
serviceId | specifies the identifier of the service. |
serviceType | specifies the type of the service. |
controlUrl | specifies the URL for control. |
eventSubUrl | specifies the URL for eventing. |
scpdUrl | specifies the URL for service description. |
incReq | specifies whether the service is required or optional. This parameter is optional. |
checkLevel | specifies the level of strictness used in validating the specified arguments. This parameter is optional. |
err | specifies a pointer to a QString that will contain an error description in case the construction failed. This is optional. |
~HServiceInfo | ( | ) |
Destroys the instance.
HServiceInfo | ( | const HServiceInfo & | other | ) |
Copy constructor.
Copies the contents of the other
to this.
other | specifies the object to be copied. |
HServiceInfo& operator= | ( | const HServiceInfo & | other | ) |
Assignment operator.
Assigns the contents of the other to this.
other | specifies the object to be copied. |
bool isValid | ( | HValidityCheckLevel | level | ) | const |
Indicates if the object is valid.
A valid object contains the mandatory data of a UPnP service.
level | specifies the level of strictness used in validating the object. This parameter is optional and the default level is strict. |
const HServiceId& serviceId | ( | ) | const |
Returns the service identifier found in the device description file.
const HResourceType& serviceType | ( | ) | const |
Returns the type of the service found in the device description file.
QUrl scpdUrl | ( | ) | const |
Returns the URL for service description.
This is the URL where the service description can be retrieved. This is defined in the device description.
QUrl controlUrl | ( | ) | const |
Returns the URL for control.
This is the URL to which the action invocations must be sent. This is defined in the device description.
QUrl eventSubUrl | ( | ) | const |
Returns the URL for eventing.
This is the URL to which subscriptions and un-subscriptions are sent. This is defined in the device description.
HInclusionRequirement inclusionRequirement | ( | ) | const |
Indicates whether the service is required or optional.
H_UPNP_CORE_EXPORT bool operator== | ( | const HServiceInfo & | obj1, |
const HServiceInfo & | obj2 | ||
) | [friend] |
Compares the two objects for equality.
bool operator!= | ( | const HServiceInfo & | obj1, |
const HServiceInfo & | obj2 | ||
) | [related] |
Compares the two objects for inequality.