CyberLink for C

ccontrol.h File Reference

#include <cybergarage/typedef.h>
#include <cybergarage/util/cstring.h>
#include <cybergarage/soap/csoap.h>
#include <cybergarage/upnp/cservice.h>
#include <cybergarage/upnp/caction.h>
#include <cybergarage/upnp/cargument.h>
#include <cybergarage/upnp/cstatevariable.h>

Data Structures

struct  _CgUpnpActionResponse
struct  _CgUpnpActionRequest
struct  _CgUpnpQueryResponse
struct  _CgUpnpQueryRequest

Defines

#define CG_UPNP_MAN_DISCOVER   "\"ssdp:discover\""
#define CG_UPNP_NT_ROOTDEVICE   "upnp:rootdevice"
#define CG_UPNP_NT_EVENT   "upnp:event"
#define CG_UPNP_NTS_ALIVE   "ssdp:alive"
#define CG_UPNP_NTS_BYEBYE   "ssdp:byebye"
#define CG_UPNP_NTS_PROPCHANGE   "upnp:propchange"
#define CG_UPNP_ST_ALL_DEVICE   "ssdp:all"
#define CG_UPNP_ST_ROOT_DEVICE   "upnp:rootdevice"
#define CG_UPNP_ST_UUID_DEVICE   "uuid"
#define CG_UPNP_ST_URN   "urn"
#define CG_UPNP_ST_URN_DEVICE   "urn:schemas-upnp-org:device"
#define CG_UPNP_ST_URN_SERVICE   "urn:schemas-upnp-org:service"
#define CG_UPNP_USN_ROOTDEVICE   "upnp:rootdevice"
#define CG_UPNP_CONTROL_NS   "u"
#define CG_UPNP_CONTROL_QUERY_SOAPACTION   "\"urn:schemas-upnp-org:control-1-0#QueryStateVariable\""
#define CG_UPNP_CONTROL_XMLNS   "urn:schemas-upnp-org:control-1-0"
#define CG_UPNP_CONTROL_QUERY_STATE_VARIABLE   "QueryStateVariable"
#define CG_UPNP_CONTROL_QUERY_STATE_VARIABLE_RESPONSE   "QueryStateVariableResponse"
#define CG_UPNP_CONTROL_VAR_NAME   "varName"
#define CG_UPNP_CONTROL_RETURN   "return"
#define CG_UPNP_CONTROL_FAULT_CODE   "Client"
#define CG_UPNP_CONTROL_FAULT_STRING   "UPnPError"
#define CG_UPNP_CONTROL_ERROR_CODE   "errorCode"
#define CG_UPNP_CONTROL_ERROR_DESCRIPTION   "errorDescription"
#define cg_upnp_control_isqueryrequest(httpReq)   ( ((0 <= cg_strstr(cg_soap_request_getsoapaction(httpReq), CG_UPNP_CONTROL_QUERY_SOAPACTION)) ? TRUE : FALSE) || ((0 <= cg_strstr(cg_soap_request_getsoapactionwithns(httpReq), CG_UPNP_CONTROL_QUERY_SOAPACTION)) ? TRUE : FALSE) )
#define cg_upnp_control_isactionrequest(httpReq)   ((cg_upnp_control_isqueryrequest(httpReq) == TRUE) ? FALSE : TRUE)
#define cg_upnp_control_action_request_getsoaprequest(actionReq)   (actionReq->soapReq)
#define cg_upnp_control_action_request_getargumentlist(actionReq)   (actionReq->argList)
#define cg_upnp_control_action_request_getactionresponse(actionReq)   (actionReq->actionRes)
#define cg_upnp_control_action_response_getsoapresponse(actionRes)   (actionRes->soapRes)
#define cg_upnp_control_action_response_issuccessful(actionRes)   cg_soap_response_issuccessful(actionRes->soapRes)
#define cg_upnp_control_query_request_getsoaprequest(queryReq)   (queryReq->soapReq)
#define cg_upnp_control_query_request_getqueryresponse(queryReq)   (queryReq->queryRes)
#define cg_upnp_control_query_response_getsoapresponse(queryRes)   (queryRes->soapRes)
#define cg_upnp_control_query_response_issuccessful(queryRes)   cg_soap_response_issuccessful(queryRes->soapRes)
#define cg_upnp_man_isdiscover(str)   ((0 == cg_strstr(str, CG_UPNP_MAN_DISCOVER)) ? TRUE : FALSE)
#define cg_upnp_st_isalldevice(str)   ((0 <= cg_strstr(str, CG_UPNP_ST_ALL_DEVICE)) ? TRUE : FALSE)
#define cg_upnp_st_isrootdevice(str)   ((0 <= cg_strstr(str, CG_UPNP_ST_ROOT_DEVICE)) ? TRUE : FALSE)
#define cg_upnp_st_isuuiddevice(str)   ((0 <= cg_strstr(str, CG_UPNP_ST_UUID_DEVICE)) ? TRUE : FALSE)
#define cg_upnp_st_isurn(str)   ((0 <= cg_strstr(str, CG_UPNP_ST_URN)) ? TRUE : FALSE)
#define cg_upnp_st_isurndevice(str)   ((0 <= cg_strstr(str, CG_UPNP_ST_URN_DEVICE)) ? TRUE : FALSE)
#define cg_upnp_st_isurnservice(str)   ((0 <= cg_strstr(str, CG_UPNP_ST_URN_SERVICE)) ? TRUE : FALSE)
#define cg_upnp_nt_isrootdevice(str)   ((0 <= cg_strstr(str, CG_UPNP_NT_ROOTDEVICE)) ? TRUE : FALSE)
#define cg_upnp_nts_isalive(str)   ((0 <= cg_strstr(str, CG_UPNP_NTS_ALIVE)) ? TRUE : FALSE)
#define cg_upnp_nts_isbyebye(str)   ((0 <= cg_strstr(str, CG_UPNP_NTS_BYEBYE)) ? TRUE : FALSE)
#define cg_upnp_nts_ispropchange(str)   ((0 <= cg_strstr(str, CG_UPNP_NTS_PROPCHANGE)) ? TRUE : FALSE)
#define cg_upnp_usn_isrootdevice(str)   ((0 <= cg_strstr(str, CG_UPNP_USN_ROOTDEVICE)) ? TRUE : FALSE)

Typedefs

typedef struct
_CgUpnpActionResponse 
CgUpnpActionResponse
typedef struct _CgUpnpActionRequest CgUpnpActionRequest
typedef struct _CgUpnpQueryResponse CgUpnpQueryResponse
typedef struct _CgUpnpQueryRequest CgUpnpQueryRequest

Functions

void cg_upnp_control_soap_request_initializeenvelopenode (CgSoapRequest *soapReq)
void cg_upnp_control_soap_response_initializeenvelopenode (CgSoapResponse *soapRes)
CgXmlNode * cg_upnp_control_soap_response_createfaultresponsenode (int errCode, char *errDescr)
void cg_upnp_control_soap_response_setfaultresponse (CgSoapResponse *soapRes, int errCode, char *errDescr)
BOOL cg_upnp_action_performlistner (CgUpnpAction *action, CgUpnpActionRequest *actionReq)
BOOL cg_upnp_statevariable_performlistner (CgUpnpStateVariable *statVar, CgUpnpQueryRequest *queryReq)
void cg_upnp_control_request_sethostfromservice (CgSoapRequest *soapReq, CgUpnpService *service)
CgUpnpActionRequest * cg_upnp_control_action_request_new ()
void cg_upnp_control_action_request_delete (CgUpnpActionRequest *actionReq)
void cg_upnp_control_action_request_clear (CgUpnpActionRequest *actionReq)
void cg_upnp_control_action_request_setsoaprequest (CgUpnpActionRequest *actionReq, CgSoapRequest *soapReq)
CgXmlNode * cg_upnp_control_action_request_getactionnode (CgUpnpActionRequest *actionReq)
char * cg_upnp_control_action_request_getactionname (CgUpnpActionRequest *actionReq)
void cg_upnp_control_action_request_setaction (CgUpnpActionRequest *actionReq, CgUpnpAction *action)
CgUpnpActionResponse * cg_upnp_control_action_request_post (CgUpnpActionRequest *actionReq)
CgUpnpActionResponse * cg_upnp_control_action_response_new ()
void cg_upnp_control_action_response_delete (CgUpnpActionResponse *actionReq)
void cg_upnp_control_action_response_clear (CgUpnpActionResponse *actionReq)
void cg_upnp_control_action_response_setsoapresponse (CgUpnpActionResponse *actionRes, CgSoapResponse *soapRes)
void cg_upnp_control_action_response_setresponse (CgUpnpActionResponse *actionRes, CgUpnpAction *action)
CgXmlNode * cg_upnp_control_action_response_getactionresponsenode (CgUpnpActionResponse *actionRes)
BOOL cg_upnp_control_action_response_getresult (CgUpnpActionResponse *actionRes, CgUpnpAction *action)
BOOL cg_upnp_control_action_response_geterror (CgUpnpActionResponse *actionRes, CgUpnpAction *action)
CgUpnpQueryRequest * cg_upnp_control_query_request_new ()
void cg_upnp_control_query_request_delete (CgUpnpQueryRequest *queryReq)
void cg_upnp_control_query_request_clear (CgUpnpQueryRequest *queryReq)
void cg_upnp_control_query_request_setsoaprequest (CgUpnpQueryRequest *queryReq, CgSoapRequest *soapReq)
CgXmlNode * cg_upnp_control_query_request_getvarnamenode (CgUpnpQueryRequest *queryReq)
char * cg_upnp_control_query_request_getvarname (CgUpnpQueryRequest *queryReq)
void cg_upnp_control_query_request_setstatevariable (CgUpnpQueryRequest *queryReq, CgUpnpStateVariable *statVar)
CgUpnpQueryResponse * cg_upnp_control_query_request_post (CgUpnpQueryRequest *queryReq)
CgUpnpQueryResponse * cg_upnp_control_query_response_new ()
void cg_upnp_control_query_response_delete (CgUpnpQueryResponse *queryReq)
void cg_upnp_control_query_response_clear (CgUpnpQueryResponse *queryReq)
void cg_upnp_control_query_response_setsoapresponse (CgUpnpQueryResponse *queryRes, CgSoapResponse *soapRes)
void cg_upnp_control_query_response_setresponse (CgUpnpQueryResponse *queryRes, CgUpnpStateVariable *statVar)
CgXmlNode * cg_upnp_control_query_response_getreturnnode (CgUpnpQueryResponse *queryRes)
char * cg_upnp_control_query_response_getreturnvalue (CgUpnpQueryResponse *queryRes)
char * cg_upnp_usn_getudn (char *usn, char *udnBuf, int udnBufLen)
BOOL cg_upnp_action_post (CgUpnpAction *action)
BOOL cg_upnp_statevariable_post (CgUpnpStateVariable *statVar)

Define Documentation

#define cg_upnp_control_action_request_getactionresponse (   actionReq)    (actionReq->actionRes)

Get action response from action request

Parameters:
actionReqAction request
Returns:
Action response
#define cg_upnp_control_action_request_getargumentlist (   actionReq)    (actionReq->argList)

Get argument list from action request

Parameters:
actionReqAction request
Returns:
Argument list
#define cg_upnp_control_action_request_getsoaprequest (   actionReq)    (actionReq->soapReq)

Get soap request associated with action request

Parameters:
actionReqAction request
Returns:
Soap request
#define cg_upnp_control_action_response_getsoapresponse (   actionRes)    (actionRes->soapRes)

Get soap response from action response

Parameters:
actionResAction response
Returns:
Soap response
#define cg_upnp_control_action_response_issuccessful (   actionRes)    cg_soap_response_issuccessful(actionRes->soapRes)

Check if action response indicates that action invoke was successfull

Parameters:
actionResAction response
Returns:
True if action has been successful, false otherwise
#define CG_UPNP_CONTROL_ERROR_CODE   "errorCode"

Definition fro control error code

#define CG_UPNP_CONTROL_ERROR_DESCRIPTION   "errorDescription"

Definition for control error description

#define CG_UPNP_CONTROL_FAULT_CODE   "Client"

Definition for control fault code

#define CG_UPNP_CONTROL_FAULT_STRING   "UPnPError"

Definition for contol fault string

#define cg_upnp_control_isactionrequest (   httpReq)    ((cg_upnp_control_isqueryrequest(httpReq) == TRUE) ? FALSE : TRUE)
#define cg_upnp_control_isqueryrequest (   httpReq)    ( ((0 <= cg_strstr(cg_soap_request_getsoapaction(httpReq), CG_UPNP_CONTROL_QUERY_SOAPACTION)) ? TRUE : FALSE) || ((0 <= cg_strstr(cg_soap_request_getsoapactionwithns(httpReq), CG_UPNP_CONTROL_QUERY_SOAPACTION)) ? TRUE : FALSE) )

Check if HTTP request query is UPnP query request

Parameters:
httpReqHTTP request
Returns:
True if request is UPnP query request, false othewise
#define CG_UPNP_CONTROL_NS   "u"

Definition for control name space

#define cg_upnp_control_query_request_getqueryresponse (   queryReq)    (queryReq->queryRes)

Get response from query request

Parameters:
queryReqQuery request
Returns:
Query response
#define cg_upnp_control_query_request_getsoaprequest (   queryReq)    (queryReq->soapReq)

Get soap request from query request

Parameters:
queryReq
Returns:
Soap request
#define cg_upnp_control_query_response_getsoapresponse (   queryRes)    (queryRes->soapRes)

Get soap response from query response

Parameters:
queryResQuery response
Returns:
Soap response
#define cg_upnp_control_query_response_issuccessful (   queryRes)    cg_soap_response_issuccessful(queryRes->soapRes)

Check if query response indicates that query request has succeeded

Parameters:
queryResQuery response
#define CG_UPNP_CONTROL_QUERY_SOAPACTION   "\"urn:schemas-upnp-org:control-1-0#QueryStateVariable\""

Definition for soap action: state variable query

#define CG_UPNP_CONTROL_QUERY_STATE_VARIABLE   "QueryStateVariable"

Definition for query state variable

#define CG_UPNP_CONTROL_QUERY_STATE_VARIABLE_RESPONSE   "QueryStateVariableResponse"

Definition for query state variable response

#define CG_UPNP_CONTROL_RETURN   "return"

Definition for control return

#define CG_UPNP_CONTROL_VAR_NAME   "varName"

Definition for control variable name

#define CG_UPNP_CONTROL_XMLNS   "urn:schemas-upnp-org:control-1-0"

Definition for control XML name space

#define CG_UPNP_MAN_DISCOVER   "\"ssdp:discover\""

Definition for mandatory discover header

#define cg_upnp_man_isdiscover (   str)    ((0 == cg_strstr(str, CG_UPNP_MAN_DISCOVER)) ? TRUE : FALSE)

Check if string is correct mandatory header value as specified in UPnP Device Architecture 1.2.2

Parameters:
strString to be checked
Returns:
True if string is exactly the required one, false otherwise
#define CG_UPNP_NT_EVENT   "upnp:event"

Definition for NT event

#define cg_upnp_nt_isrootdevice (   str)    ((0 <= cg_strstr(str, CG_UPNP_NT_ROOTDEVICE)) ? TRUE : FALSE)

Check if NT (notification target) is for root device

Parameters:
strString to be checked
Returns:
True if NT is for root device, false otherwise
#define CG_UPNP_NT_ROOTDEVICE   "upnp:rootdevice"

Definition for NT (Notification type) root device

#define CG_UPNP_NTS_ALIVE   "ssdp:alive"

Definition for NTS alive

#define CG_UPNP_NTS_BYEBYE   "ssdp:byebye"

Definition for NTS byebye

#define cg_upnp_nts_isalive (   str)    ((0 <= cg_strstr(str, CG_UPNP_NTS_ALIVE)) ? TRUE : FALSE)

Check if NTS (notification sub target) is of type "alive"

Parameters:
strString to be checked
Returns:
True if string is of type "alive", false otherwise
#define cg_upnp_nts_isbyebye (   str)    ((0 <= cg_strstr(str, CG_UPNP_NTS_BYEBYE)) ? TRUE : FALSE)

Check if string type is "byebye"

Parameters:
strString to be checked
Returns:
True if string is of type "byebye", false othewise
#define cg_upnp_nts_ispropchange (   str)    ((0 <= cg_strstr(str, CG_UPNP_NTS_PROPCHANGE)) ? TRUE : FALSE)

Check if string type is "property change"

Parameters:
strString to be checked
Returns:
True if string type is "property change"
#define CG_UPNP_NTS_PROPCHANGE   "upnp:propchange"

Definition for NTS property change

#define CG_UPNP_ST_ALL_DEVICE   "ssdp:all"

Definition for general ST (search target)

#define cg_upnp_st_isalldevice (   str)    ((0 <= cg_strstr(str, CG_UPNP_ST_ALL_DEVICE)) ? TRUE : FALSE)

Check if device is of type "all"

Parameters:
strString to be checked
Returns:
True if device type is "all", false otherwise
#define cg_upnp_st_isrootdevice (   str)    ((0 <= cg_strstr(str, CG_UPNP_ST_ROOT_DEVICE)) ? TRUE : FALSE)

Check if device string is from root device

Parameters:
strString to be checked
Returns:
True if string is from device type "root device", false otherwise
#define cg_upnp_st_isurn (   str)    ((0 <= cg_strstr(str, CG_UPNP_ST_URN)) ? TRUE : FALSE)

Check if string is from urn

Parameters:
strString to be checked
Returns:
True if string is from urn, false otherwise
#define cg_upnp_st_isurndevice (   str)    ((0 <= cg_strstr(str, CG_UPNP_ST_URN_DEVICE)) ? TRUE : FALSE)

Check if string is from urn device

Parameters:
strString to be checked
Returns:
True if string is from urn device, false otherwise
#define cg_upnp_st_isurnservice (   str)    ((0 <= cg_strstr(str, CG_UPNP_ST_URN_SERVICE)) ? TRUE : FALSE)

Check if string is from urn service

Parameters:
strString to be checked
Returns:
True if string is from urn service, false otherwise
#define cg_upnp_st_isuuiddevice (   str)    ((0 <= cg_strstr(str, CG_UPNP_ST_UUID_DEVICE)) ? TRUE : FALSE)

Check if string is from uuid device

Parameters:
strString to be checked
Returns:
True if string is from uuid device, false otherwise
#define CG_UPNP_ST_ROOT_DEVICE   "upnp:rootdevice"

Definition for root device ST

#define CG_UPNP_ST_URN   "urn"

Definition for URN device

#define CG_UPNP_ST_URN_DEVICE   "urn:schemas-upnp-org:device"

Definition for URN device

#define CG_UPNP_ST_URN_SERVICE   "urn:schemas-upnp-org:service"

Definition for URN service

#define CG_UPNP_ST_UUID_DEVICE   "uuid"

Definition for ST UUID (universally unique identifier) prefix

#define cg_upnp_usn_isrootdevice (   str)    ((0 <= cg_strstr(str, CG_UPNP_USN_ROOTDEVICE)) ? TRUE : FALSE)

Check if usn is from root device

Parameters:
strString to be checked
Returns:
True if usn associates to root device, false otherwise
#define CG_UPNP_USN_ROOTDEVICE   "upnp:rootdevice"

Definition for USN rootdevice


Typedef Documentation

Data type definition for action request

Data type definition for action response

Data type definition for query request

Data type definition for query response


Function Documentation

BOOL cg_upnp_action_performlistner ( CgUpnpAction *  action,
CgUpnpActionRequest *  actionReq 
)

Perform action listener

Parameters:
actionAction
actionReqAction request
BOOL cg_upnp_action_post ( CgUpnpAction *  action)

Send action

Parameters:
actionAction
void cg_upnp_control_action_request_clear ( CgUpnpActionRequest *  actionReq)

Clear action request

Parameters:
actionReqClear Action request
void cg_upnp_control_action_request_delete ( CgUpnpActionRequest *  actionReq)

Delete action request object

Parameters:
actionReqAction request
char* cg_upnp_control_action_request_getactionname ( CgUpnpActionRequest *  actionReq)

Get action name from action request

Parameters:
actionReqAction request
Returns:
Action name
CgXmlNode* cg_upnp_control_action_request_getactionnode ( CgUpnpActionRequest *  actionReq)

Get XML action node from action request

Parameters:
actionReq
Returns:
Action request XML node
CgUpnpActionRequest* cg_upnp_control_action_request_new ( )

Create new action request object

CgUpnpActionResponse* cg_upnp_control_action_request_post ( CgUpnpActionRequest *  actionReq)

Send action request

Parameters:
actionReqAction request
void cg_upnp_control_action_request_setaction ( CgUpnpActionRequest *  actionReq,
CgUpnpAction *  action 
)

Set action to action request

Parameters:
actionReqAction request
actionUPnP action
void cg_upnp_control_action_request_setsoaprequest ( CgUpnpActionRequest *  actionReq,
CgSoapRequest *  soapReq 
)

Set soap request associated with action request

Parameters:
actionReqAction request
soapReqSoap request
void cg_upnp_control_action_response_clear ( CgUpnpActionResponse *  actionReq)

Clear action response

Parameters:
actionReqAction response
void cg_upnp_control_action_response_delete ( CgUpnpActionResponse *  actionReq)

Delete action response

Parameters:
actionReqAction response
CgXmlNode* cg_upnp_control_action_response_getactionresponsenode ( CgUpnpActionResponse *  actionRes)

Get action response XML node from action response

Parameters:
actionResAction response
Returns:
Action response XML node
BOOL cg_upnp_control_action_response_geterror ( CgUpnpActionResponse *  actionRes,
CgUpnpAction *  action 
)

Get error associated to action response

Todo:
Check this out more carefully
Parameters:
actionResAction response
actionUPnP action
BOOL cg_upnp_control_action_response_getresult ( CgUpnpActionResponse *  actionRes,
CgUpnpAction *  action 
)

Get result from action response

Todo:
Check this out more carefully
Parameters:
actionResAction response
actionUPnP action
CgUpnpActionResponse* cg_upnp_control_action_response_new ( )

Create new action response

void cg_upnp_control_action_response_setresponse ( CgUpnpActionResponse *  actionRes,
CgUpnpAction *  action 
)

Set action response to action

Parameters:
actionResAction response
actionUPnP action
void cg_upnp_control_action_response_setsoapresponse ( CgUpnpActionResponse *  actionRes,
CgSoapResponse *  soapRes 
)

Set soap response to action response

Parameters:
actionResAction response
soapResSoap reaponse
void cg_upnp_control_query_request_clear ( CgUpnpQueryRequest *  queryReq)

Clear query request

Parameters:
queryReqQuery request
void cg_upnp_control_query_request_delete ( CgUpnpQueryRequest *  queryReq)

Delete query request

Parameters:
queryReqQuery request
char* cg_upnp_control_query_request_getvarname ( CgUpnpQueryRequest *  queryReq)

Get state variable name associated with this query request

Parameters:
queryReqQuery request
Returns:
State variable variable name
CgXmlNode* cg_upnp_control_query_request_getvarnamenode ( CgUpnpQueryRequest *  queryReq)

Get state variable XML node

Parameters:
queryReq
Returns:
State variable XML node
CgUpnpQueryRequest* cg_upnp_control_query_request_new ( )

Create new query request object

CgUpnpQueryResponse* cg_upnp_control_query_request_post ( CgUpnpQueryRequest *  queryReq)

Send query request

Parameters:
queryReqQuery request
Returns:
Query response
void cg_upnp_control_query_request_setsoaprequest ( CgUpnpQueryRequest *  queryReq,
CgSoapRequest *  soapReq 
)

Set soap request for query request

Parameters:
queryReqQuery request
soapReqSoap request
void cg_upnp_control_query_request_setstatevariable ( CgUpnpQueryRequest *  queryReq,
CgUpnpStateVariable *  statVar 
)

Set state variable to query request

Parameters:
queryReqQuery request
statVarState variable
void cg_upnp_control_query_response_clear ( CgUpnpQueryResponse *  queryReq)

Clear query response

Parameters:
queryReqQuery request
void cg_upnp_control_query_response_delete ( CgUpnpQueryResponse *  queryReq)

Delete query response

Parameters:
queryReqQuery request
CgXmlNode* cg_upnp_control_query_response_getreturnnode ( CgUpnpQueryResponse *  queryRes)

Get XML return node from query response

Parameters:
queryRes
Returns:
XML return node
char* cg_upnp_control_query_response_getreturnvalue ( CgUpnpQueryResponse *  queryRes)

Get return valuse from query response

Parameters:
queryResQuery response
Returns:
UPnP return value
CgUpnpQueryResponse* cg_upnp_control_query_response_new ( )

Create new query response

void cg_upnp_control_query_response_setresponse ( CgUpnpQueryResponse *  queryRes,
CgUpnpStateVariable *  statVar 
)

Create and set XML response data into query response

Parameters:
queryResQuery response
statVarState variable
void cg_upnp_control_query_response_setsoapresponse ( CgUpnpQueryResponse *  queryRes,
CgSoapResponse *  soapRes 
)

Set soap response for query response

Parameters:
queryResQuery response
soapResSoap response
void cg_upnp_control_request_sethostfromservice ( CgSoapRequest *  soapReq,
CgUpnpService *  service 
)

Set host from service

Parameters:
soapReqSoap request
serviceUPnP service
void cg_upnp_control_soap_request_initializeenvelopenode ( CgSoapRequest *  soapReq)

Initializes soap requests envelope node

Parameters:
soapReqSoap request
CgXmlNode* cg_upnp_control_soap_response_createfaultresponsenode ( int  errCode,
char *  errDescr 
)
void cg_upnp_control_soap_response_initializeenvelopenode ( CgSoapResponse *  soapRes)

Initialize soap responses envelope node

Parameters:
soapResSoap response
void cg_upnp_control_soap_response_setfaultresponse ( CgSoapResponse *  soapRes,
int  errCode,
char *  errDescr 
)

Set failed response data

Parameters:
soapResSoap response
errCodeError code
errDescrError description
BOOL cg_upnp_statevariable_performlistner ( CgUpnpStateVariable *  statVar,
CgUpnpQueryRequest *  queryReq 
)

Perform query listener

Parameters:
statVarState variable
queryReqQuery request
BOOL cg_upnp_statevariable_post ( CgUpnpStateVariable *  statVar)

Send query

Parameters:
statVarState variable
char* cg_upnp_usn_getudn ( char *  usn,
char *  udnBuf,
int  udnBufLen 
)

Get udn from usn

Parameters:
usnUniversal serial number
udnBufBuffer where udn is stored after successfull execution
udnBufLenBuffer length for udnBuf
Returns:
Pointer to beginning of udnBuf.