#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>
#define cg_upnp_control_action_request_getactionresponse | ( | actionReq | ) | (actionReq->actionRes) |
Get action response from action request
actionReq | Action request |
#define cg_upnp_control_action_request_getargumentlist | ( | actionReq | ) | (actionReq->argList) |
Get argument list from action request
actionReq | Action request |
#define cg_upnp_control_action_request_getsoaprequest | ( | actionReq | ) | (actionReq->soapReq) |
Get soap request associated with action request
actionReq | Action request |
#define cg_upnp_control_action_response_getsoapresponse | ( | actionRes | ) | (actionRes->soapRes) |
Get soap response from action response
actionRes | Action 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
actionRes | Action response |
#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
httpReq | HTTP request |
#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
queryReq | Query request |
#define cg_upnp_control_query_request_getsoaprequest | ( | queryReq | ) | (queryReq->soapReq) |
Get soap request from query request
queryReq |
#define cg_upnp_control_query_response_getsoapresponse | ( | queryRes | ) | (queryRes->soapRes) |
Get soap response from query response
queryRes | Query 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
queryRes | Query 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
str | String to be checked |
#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
str | String to be checked |
#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"
str | String to be checked |
#define cg_upnp_nts_isbyebye | ( | str | ) | ((0 <= cg_strstr(str, CG_UPNP_NTS_BYEBYE)) ? TRUE : FALSE) |
Check if string type is "byebye"
str | String to be checked |
#define cg_upnp_nts_ispropchange | ( | str | ) | ((0 <= cg_strstr(str, CG_UPNP_NTS_PROPCHANGE)) ? TRUE : FALSE) |
Check if string type is "property change"
str | String to be checked |
#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"
str | String to be checked |
#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
str | String to be checked |
#define cg_upnp_st_isurndevice | ( | str | ) | ((0 <= cg_strstr(str, CG_UPNP_ST_URN_DEVICE)) ? TRUE : FALSE) |
Check if string is from urn device
str | String to be checked |
#define cg_upnp_st_isurnservice | ( | str | ) | ((0 <= cg_strstr(str, CG_UPNP_ST_URN_SERVICE)) ? TRUE : FALSE) |
Check if string is from urn service
str | String to be checked |
#define cg_upnp_st_isuuiddevice | ( | str | ) | ((0 <= cg_strstr(str, CG_UPNP_ST_UUID_DEVICE)) ? TRUE : FALSE) |
Check if string is from uuid device
str | String to be checked |
#define CG_UPNP_ST_ROOT_DEVICE "upnp:rootdevice" |
Definition for root device ST
#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
str | String to be checked |
#define CG_UPNP_USN_ROOTDEVICE "upnp:rootdevice" |
Definition for USN rootdevice
typedef struct _CgUpnpActionRequest CgUpnpActionRequest |
Data type definition for action request
typedef struct _CgUpnpActionResponse CgUpnpActionResponse |
Data type definition for action response
typedef struct _CgUpnpQueryRequest CgUpnpQueryRequest |
Data type definition for query request
typedef struct _CgUpnpQueryResponse CgUpnpQueryResponse |
Data type definition for query response
BOOL cg_upnp_action_performlistner | ( | CgUpnpAction * | action, | |
CgUpnpActionRequest * | actionReq | |||
) |
Perform action listener
action | Action | |
actionReq | Action request |
BOOL cg_upnp_action_post | ( | CgUpnpAction * | action | ) |
Send action
action | Action |
void cg_upnp_control_action_request_clear | ( | CgUpnpActionRequest * | actionReq | ) |
Clear action request
actionReq | Clear Action request |
void cg_upnp_control_action_request_delete | ( | CgUpnpActionRequest * | actionReq | ) |
Delete action request object
actionReq | Action request |
char* cg_upnp_control_action_request_getactionname | ( | CgUpnpActionRequest * | actionReq | ) |
Get action name from action request
actionReq | Action request |
CgXmlNode* cg_upnp_control_action_request_getactionnode | ( | CgUpnpActionRequest * | actionReq | ) |
Get XML action node from action request
actionReq |
CgUpnpActionRequest* cg_upnp_control_action_request_new | ( | ) |
Create new action request object
CgUpnpActionResponse* cg_upnp_control_action_request_post | ( | CgUpnpActionRequest * | actionReq | ) |
Send action request
actionReq | Action request |
void cg_upnp_control_action_request_setaction | ( | CgUpnpActionRequest * | actionReq, | |
CgUpnpAction * | action | |||
) |
Set action to action request
actionReq | Action request | |
action | UPnP action |
void cg_upnp_control_action_request_setsoaprequest | ( | CgUpnpActionRequest * | actionReq, | |
CgSoapRequest * | soapReq | |||
) |
Set soap request associated with action request
actionReq | Action request | |
soapReq | Soap request |
void cg_upnp_control_action_response_clear | ( | CgUpnpActionResponse * | actionReq | ) |
Clear action response
actionReq | Action response |
void cg_upnp_control_action_response_delete | ( | CgUpnpActionResponse * | actionReq | ) |
Delete action response
actionReq | Action response |
CgXmlNode* cg_upnp_control_action_response_getactionresponsenode | ( | CgUpnpActionResponse * | actionRes | ) |
Get action response XML node from action response
actionRes | Action response |
BOOL cg_upnp_control_action_response_geterror | ( | CgUpnpActionResponse * | actionRes, | |
CgUpnpAction * | action | |||
) |
Get error associated to action response
actionRes | Action response | |
action | UPnP action |
BOOL cg_upnp_control_action_response_getresult | ( | CgUpnpActionResponse * | actionRes, | |
CgUpnpAction * | action | |||
) |
Get result from action response
actionRes | Action response | |
action | UPnP 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
actionRes | Action response | |
action | UPnP action |
void cg_upnp_control_action_response_setsoapresponse | ( | CgUpnpActionResponse * | actionRes, | |
CgSoapResponse * | soapRes | |||
) |
Set soap response to action response
actionRes | Action response | |
soapRes | Soap reaponse |
void cg_upnp_control_query_request_clear | ( | CgUpnpQueryRequest * | queryReq | ) |
Clear query request
queryReq | Query request |
void cg_upnp_control_query_request_delete | ( | CgUpnpQueryRequest * | queryReq | ) |
Delete query request
queryReq | Query request |
char* cg_upnp_control_query_request_getvarname | ( | CgUpnpQueryRequest * | queryReq | ) |
Get state variable name associated with this query request
queryReq | Query request |
CgXmlNode* cg_upnp_control_query_request_getvarnamenode | ( | CgUpnpQueryRequest * | queryReq | ) |
Get state variable XML node
queryReq |
CgUpnpQueryRequest* cg_upnp_control_query_request_new | ( | ) |
Create new query request object
CgUpnpQueryResponse* cg_upnp_control_query_request_post | ( | CgUpnpQueryRequest * | queryReq | ) |
Send query request
queryReq | Query request |
void cg_upnp_control_query_request_setsoaprequest | ( | CgUpnpQueryRequest * | queryReq, | |
CgSoapRequest * | soapReq | |||
) |
Set soap request for query request
queryReq | Query request | |
soapReq | Soap request |
void cg_upnp_control_query_request_setstatevariable | ( | CgUpnpQueryRequest * | queryReq, | |
CgUpnpStateVariable * | statVar | |||
) |
Set state variable to query request
queryReq | Query request | |
statVar | State variable |
void cg_upnp_control_query_response_clear | ( | CgUpnpQueryResponse * | queryReq | ) |
Clear query response
queryReq | Query request |
void cg_upnp_control_query_response_delete | ( | CgUpnpQueryResponse * | queryReq | ) |
Delete query response
queryReq | Query request |
CgXmlNode* cg_upnp_control_query_response_getreturnnode | ( | CgUpnpQueryResponse * | queryRes | ) |
Get XML return node from query response
queryRes |
char* cg_upnp_control_query_response_getreturnvalue | ( | CgUpnpQueryResponse * | queryRes | ) |
Get return valuse from query response
queryRes | Query response |
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
queryRes | Query response | |
statVar | State variable |
void cg_upnp_control_query_response_setsoapresponse | ( | CgUpnpQueryResponse * | queryRes, | |
CgSoapResponse * | soapRes | |||
) |
Set soap response for query response
queryRes | Query response | |
soapRes | Soap response |
void cg_upnp_control_request_sethostfromservice | ( | CgSoapRequest * | soapReq, | |
CgUpnpService * | service | |||
) |
Set host from service
soapReq | Soap request | |
service | UPnP service |
void cg_upnp_control_soap_request_initializeenvelopenode | ( | CgSoapRequest * | soapReq | ) |
Initializes soap requests envelope node
soapReq | Soap 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
soapRes | Soap response |
void cg_upnp_control_soap_response_setfaultresponse | ( | CgSoapResponse * | soapRes, | |
int | errCode, | |||
char * | errDescr | |||
) |
Set failed response data
soapRes | Soap response | |
errCode | Error code | |
errDescr | Error description |
BOOL cg_upnp_statevariable_performlistner | ( | CgUpnpStateVariable * | statVar, | |
CgUpnpQueryRequest * | queryReq | |||
) |
Perform query listener
statVar | State variable | |
queryReq | Query request |
BOOL cg_upnp_statevariable_post | ( | CgUpnpStateVariable * | statVar | ) |
Send query
statVar | State variable |
char* cg_upnp_usn_getudn | ( | char * | usn, | |
char * | udnBuf, | |||
int | udnBufLen | |||
) |
Get udn from usn
usn | Universal serial number | |
udnBuf | Buffer where udn is stored after successfull execution | |
udnBufLen | Buffer length for udnBuf |