CGUpnpService Class Reference
#include <CGUpnpService.h>
Inheritance diagram for CGUpnpService:
Instance Methods | |
| (id) | - initWithCObject: |
| (BOOL) | - parseXMLDescription: |
| (NSString *) | - serviceId |
| (NSString *) | - serviceType |
| (NSArray *) | - actions |
| (NSArray *) | - stateVariables |
| (CGUpnpAction *) | - getActionForName: |
| (CGUpnpStateVariable *) | - getStateVariableForName: |
| (BOOL) | - isStateVariableImpemented: |
Properties | |
| mUpnpService * | cObject |
Detailed Description
The CGUpnpService class is a wrapper class for mUpnpService of mUPnP for C.
Method Documentation
◆ actions
| - (NSArray *) actions |
Get all actions in the service as a NSArray object. The array has the actions as instances of CGUpnpAction.
- Returns
- NSArray of CGUpnpAction.
◆ getActionForName:
| - (CGUpnpAction *) getActionForName: | (NSString*) | name |
Get a action in the service by the specified name.
- Parameters
-
name A name string of the action.
- Returns
- The CGUpnpAction if the specified action is found; otherwise nil.
◆ getStateVariableForName:
| - (CGUpnpStateVariable *) getStateVariableForName: | (NSString*) | name |
Get a state variables in the service by the specified name.
- Parameters
-
name A name string of the state variable.
- Returns
- The CGUpnpStateVariable if the specified state variable is found; otherwise nil.
◆ initWithCObject:
| - (id) initWithCObject: | (mUpnpService*) | cobj |
Create a new UPnP service with the C instance.
- Returns
- New instance if successfull; otherwise nil.
◆ isStateVariableImpemented:
| - (BOOL) isStateVariableImpemented: | (NSString*) | name |
Checks whether state variable is implemented
- Parameters
-
name A name string of the state variable.
- Returns
- YES if implemented
◆ parseXMLDescription:
| - (BOOL) parseXMLDescription: | (NSString*) | xmlDesc |
Parse the specified XML description.
- Returns
- YES if successfull; otherwise nui.
◆ serviceId
| - (NSString *) serviceId |
Get the service ID of the service.
- Returns
- The service ID.
◆ serviceType
| - (NSString *) serviceType |
Get the service type of the service.
- Returns
- The service type.
◆ stateVariables
| - (NSArray *) stateVariables |
Get all state variables in the service as a NSArray object. The array has the state variables as instances of CGUpnpStateVariable.
- Returns
- NSArray of CGUpnpStateVariable.
Property Documentation
◆ cObject
|
readatomicassign |
The documentation for this class was generated from the following files:
- wrapper/objc/mUPnP/CGUpnpService.h
- wrapper/objc/mUPnP/CGUpnpService.m
