control.h File Reference

#include <mupnp/typedef.h>
#include <mupnp/util/string.h>
#include <mupnp/soap/soap.h>
#include <mupnp/service.h>
#include <mupnp/action.h>
#include <mupnp/argument.h>
#include <mupnp/statevariable.h>

Data Structures
struct	_mUpnpActionResponse
struct	_mUpnpActionRequest
struct	_mUpnpQueryResponse
struct	_mUpnpQueryRequest

Macros
#define	MUPNP_MAN_DISCOVER   "\"ssdp:discover\""
#define	MUPNP_NT_ROOTDEVICE   "upnp:rootdevice"
#define	MUPNP_NT_EVENT   "upnp:event"
#define	MUPNP_NTS_ALIVE   "ssdp:alive"
#define	MUPNP_NTS_BYEBYE   "ssdp:byebye"
#define	MUPNP_NTS_PROPCHANGE   "upnp:propchange"
#define	MUPNP_ST_ALL_DEVICE   "ssdp:all"
#define	MUPNP_ST_ROOT_DEVICE   "upnp:rootdevice"
#define	MUPNP_ST_UUID_DEVICE   "uuid"
#define	MUPNP_ST_URN   "urn"
#define	MUPNP_ST_URN_DEVICE   "urn:schemas-upnp-org:device"
#define	MUPNP_ST_URN_SERVICE   "urn:schemas-upnp-org:service"
#define	MUPNP_USN_ROOTDEVICE   "upnp:rootdevice"
#define	MUPNP_CONTROL_NS   "u"
#define	MUPNP_CONTROL_QUERY_SOAPACTION   "\"urn:schemas-upnp-org:control-1-0#QueryStateVariable\""
#define	MUPNP_CONTROL_XMLNS   "urn:schemas-upnp-org:control-1-0"
#define	MUPNP_CONTROL_QUERY_STATE_VARIABLE   "QueryStateVariable"
#define	MUPNP_CONTROL_QUERY_STATE_VARIABLE_RESPONSE   "QueryStateVariableResponse"
#define	MUPNP_CONTROL_VAR_NAME   "varName"
#define	MUPNP_CONTROL_RETURN   "return"
#define	MUPNP_CONTROL_FAULT_CODE   "Client"
#define	MUPNP_CONTROL_FAULT_STRING   "UPnPError"
#define	MUPNP_CONTROL_ERROR_CODE   "errorCode"
#define	MUPNP_CONTROL_ERROR_DESCRIPTION   "errorDescription"
#define	mupnp_control_isqueryrequest(httpReq)
#define	mupnp_control_isactionrequest(httpReq)
#define	mupnp_control_action_request_getsoaprequest(actionReq)
#define	mupnp_control_action_request_getargumentlist(actionReq)
#define	mupnp_control_action_request_getactionresponse(actionReq)
#define	mupnp_control_action_response_getsoapresponse(actionRes)
#define	mupnp_control_action_response_issuccessful(actionRes)
#define	mupnp_control_query_request_getsoaprequest(queryReq)
#define	mupnp_control_query_request_getqueryresponse(queryReq)
#define	mupnp_control_query_response_getsoapresponse(queryRes)
#define	mupnp_control_query_response_issuccessful(queryRes)
#define	mupnp_man_isdiscover(str)
#define	mupnp_st_isalldevice(str)
#define	mupnp_st_isrootdevice(str)
#define	mupnp_st_isuuiddevice(str)
#define	mupnp_st_isurn(str)
#define	mupnp_st_isurndevice(str)
#define	mupnp_st_isurnservice(str)
#define	mupnp_nt_isrootdevice(str)
#define	mupnp_nts_isalive(str)
#define	mupnp_nts_isbyebye(str)
#define	mupnp_nts_ispropchange(str)
#define	mupnp_usn_isrootdevice(str)

Typedefs
typedef struct _mUpnpActionResponse	mUpnpActionResponse
typedef struct _mUpnpActionRequest	mUpnpActionRequest
typedef struct _mUpnpQueryResponse	mUpnpQueryResponse
typedef struct _mUpnpQueryRequest	mUpnpQueryRequest

Functions
void	mupnp_control_soap_request_initializeenvelopenode (mUpnpSoapRequest *soapReq)
void	mupnp_control_soap_response_initializeenvelopenode (mUpnpSoapResponse *soapRes)
mUpnpXmlNode *	mupnp_control_soap_response_createfaultresponsenode (int errCode, char *errDescr)
void	mupnp_control_soap_response_setfaultresponse (mUpnpSoapResponse *soapRes, int errCode, char *errDescr)
bool	mupnp_action_performlistner (mUpnpAction *action, mUpnpActionRequest *actionReq)
bool	mupnp_statevariable_performlistner (mUpnpStateVariable *statVar, mUpnpQueryRequest *queryReq)
void	mupnp_control_request_sethostfromservice (mUpnpSoapRequest *soapReq, mUpnpService *service)
mUpnpActionRequest *	mupnp_control_action_request_new (void)
void	mupnp_control_action_request_delete (mUpnpActionRequest *actionReq)
void	mupnp_control_action_request_clear (mUpnpActionRequest *actionReq)
void	mupnp_control_action_request_setsoaprequest (mUpnpActionRequest *actionReq, mUpnpSoapRequest *soapReq)
mUpnpXmlNode *	mupnp_control_action_request_getactionnode (mUpnpActionRequest *actionReq)
char *	mupnp_control_action_request_getactionname (mUpnpActionRequest *actionReq)
void	mupnp_control_action_request_setaction (mUpnpActionRequest *actionReq, mUpnpAction *action)
mUpnpActionResponse *	mupnp_control_action_request_post (mUpnpActionRequest *actionReq)
mUpnpActionResponse *	mupnp_control_action_response_new (void)
void	mupnp_control_action_response_delete (mUpnpActionResponse *actionReq)
void	mupnp_control_action_response_clear (mUpnpActionResponse *actionReq)
void	mupnp_control_action_response_setsoapresponse (mUpnpActionResponse *actionRes, mUpnpSoapResponse *soapRes)
void	mupnp_control_action_response_setresponse (mUpnpActionResponse *actionRes, mUpnpAction *action)
mUpnpXmlNode *	mupnp_control_action_response_getactionresponsenode (mUpnpActionResponse *actionRes)
bool	mupnp_control_action_response_getresult (mUpnpActionResponse *actionRes, mUpnpAction *action)
bool	mupnp_control_action_response_geterror (mUpnpActionResponse *actionRes, mUpnpAction *action)
mUpnpQueryRequest *	mupnp_control_query_request_new (void)
void	mupnp_control_query_request_delete (mUpnpQueryRequest *queryReq)
void	mupnp_control_query_request_clear (mUpnpQueryRequest *queryReq)
void	mupnp_control_query_request_setsoaprequest (mUpnpQueryRequest *queryReq, mUpnpSoapRequest *soapReq)
mUpnpXmlNode *	mupnp_control_query_request_getvarnamenode (mUpnpQueryRequest *queryReq)
char *	mupnp_control_query_request_getvarname (mUpnpQueryRequest *queryReq)
void	mupnp_control_query_request_setstatevariable (mUpnpQueryRequest *queryReq, mUpnpStateVariable *statVar)
mUpnpQueryResponse *	mupnp_control_query_request_post (mUpnpQueryRequest *queryReq)
mUpnpQueryResponse *	mupnp_control_query_response_new (void)
void	mupnp_control_query_response_delete (mUpnpQueryResponse *queryReq)
void	mupnp_control_query_response_clear (mUpnpQueryResponse *queryReq)
void	mupnp_control_query_response_setsoapresponse (mUpnpQueryResponse *queryRes, mUpnpSoapResponse *soapRes)
void	mupnp_control_query_response_setresponse (mUpnpQueryResponse *queryRes, mUpnpStateVariable *statVar)
mUpnpXmlNode *	mupnp_control_query_response_getreturnnode (mUpnpQueryResponse *queryRes)
char *	mupnp_control_query_response_getreturnvalue (mUpnpQueryResponse *queryRes)
const char *	mupnp_usn_getudn (const char *usn, char *udnBuf, size_t udnBufLen)
bool	mupnp_action_post (mUpnpAction *action)
bool	mupnp_statevariable_post (mUpnpStateVariable *statVar)

Macro Definition Documentation

mupnp_control_action_request_getactionresponse

#define mupnp_control_action_request_getactionresponse

(

actionReq

)

Value:

(actionReq->actionRes)

Get action response from action request

Parameters

actionReq

Action request

Returns

Action response

mupnp_control_action_request_getargumentlist

#define mupnp_control_action_request_getargumentlist

(

actionReq

)

Value:

(actionReq->argList)

Get argument list from action request

Parameters

actionReq

Action request

Returns

Argument list

mupnp_control_action_request_getsoaprequest

#define mupnp_control_action_request_getsoaprequest

(

actionReq

)

Value:

(actionReq->soapReq)

Get soap request associated with action request

Parameters

actionReq

Action request

Returns

Soap request

mupnp_control_action_response_getsoapresponse

#define mupnp_control_action_response_getsoapresponse

(

actionRes

)

Value:

(actionRes->soapRes)

Get soap response from action response

Parameters

actionRes

Action response

Returns

Soap response

mupnp_control_action_response_issuccessful

#define mupnp_control_action_response_issuccessful

(

actionRes

)

Value:

mupnp_soap_response_issuccessful(actionRes->soapRes)

Check if action response indicates that action invoke was successfull

Parameters

actionRes

Action response

Returns

True if action has been successful, false otherwise

MUPNP_CONTROL_ERROR_CODE

#define MUPNP_CONTROL_ERROR_CODE   "errorCode"

Definition fro control error code

MUPNP_CONTROL_ERROR_DESCRIPTION

#define MUPNP_CONTROL_ERROR_DESCRIPTION   "errorDescription"

Definition for control error description

MUPNP_CONTROL_FAULT_CODE

#define MUPNP_CONTROL_FAULT_CODE   "Client"

Definition for control fault code

MUPNP_CONTROL_FAULT_STRING

#define MUPNP_CONTROL_FAULT_STRING   "UPnPError"

Definition for contol fault string

mupnp_control_isactionrequest

#define mupnp_control_isactionrequest

(

httpReq

)

Value:

((mupnp_control_isqueryrequest(httpReq) == true) ? false : true)

mupnp_control_isqueryrequest

#define mupnp_control_isqueryrequest

(

httpReq

)

Value:

(((0 <= mupnp_strstr(mupnp_soap_request_getsoapaction(httpReq), MUPNP_CONTROL_QUERY_SOAPACTION)) ? true : false) || ((0 <= mupnp_strstr(mupnp_soap_request_getsoapactionwithns(httpReq), MUPNP_CONTROL_QUERY_SOAPACTION)) ? true : false))

Check if HTTP request query is UPnP query request

Parameters

httpReq

HTTP request

Returns

True if request is UPnP query request, false othewise

MUPNP_CONTROL_NS

#define MUPNP_CONTROL_NS   "u"

Definition for control name space

mupnp_control_query_request_getqueryresponse

#define mupnp_control_query_request_getqueryresponse

(

queryReq

)

Value:

(queryReq->queryRes)

Get response from query request

Parameters

queryReq

Query request

Returns

Query response

mupnp_control_query_request_getsoaprequest

#define mupnp_control_query_request_getsoaprequest

(

queryReq

)

Value:

(queryReq->soapReq)

Get soap request from query request

Parameters

queryReq

Returns

Soap request

mupnp_control_query_response_getsoapresponse

#define mupnp_control_query_response_getsoapresponse

(

queryRes

)

Value:

(queryRes->soapRes)

Get soap response from query response

Parameters

queryRes

Query response

Returns

Soap response

mupnp_control_query_response_issuccessful

#define mupnp_control_query_response_issuccessful

(

queryRes

)

Value:

mupnp_soap_response_issuccessful(queryRes->soapRes)

Check if query response indicates that query request has succeeded

Parameters

queryRes

Query response

MUPNP_CONTROL_QUERY_SOAPACTION

#define MUPNP_CONTROL_QUERY_SOAPACTION   "\"urn:schemas-upnp-org:control-1-0#QueryStateVariable\""

Definition for soap action: state variable query

MUPNP_CONTROL_QUERY_STATE_VARIABLE

#define MUPNP_CONTROL_QUERY_STATE_VARIABLE   "QueryStateVariable"

Definition for query state variable

MUPNP_CONTROL_QUERY_STATE_VARIABLE_RESPONSE

#define MUPNP_CONTROL_QUERY_STATE_VARIABLE_RESPONSE   "QueryStateVariableResponse"

Definition for query state variable response

MUPNP_CONTROL_RETURN

#define MUPNP_CONTROL_RETURN   "return"

Definition for control return

MUPNP_CONTROL_VAR_NAME

#define MUPNP_CONTROL_VAR_NAME   "varName"

Definition for control variable name

MUPNP_CONTROL_XMLNS

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

Definition for control XML name space

MUPNP_MAN_DISCOVER

#define MUPNP_MAN_DISCOVER   "\"ssdp:discover\""

Definition for mandatory discover header

mupnp_man_isdiscover

#define mupnp_man_isdiscover

(

str

)

Value:

((0 == mupnp_strstr(str, MUPNP_MAN_DISCOVER)) ? true : false)

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

Parameters

str	String to be checked

Returns

True if string is exactly the required one, false otherwise

MUPNP_NT_EVENT

#define MUPNP_NT_EVENT   "upnp:event"

Definition for NT event

mupnp_nt_isrootdevice

#define mupnp_nt_isrootdevice

(

str

)

Value:

((0 <= mupnp_strstr(str, MUPNP_NT_ROOTDEVICE)) ? true : false)

Check if NT (notification target) is for root device

Parameters

str	String to be checked

Returns

True if NT is for root device, false otherwise

MUPNP_NT_ROOTDEVICE

#define MUPNP_NT_ROOTDEVICE   "upnp:rootdevice"

Definition for NT (Notification type) root device

MUPNP_NTS_ALIVE

#define MUPNP_NTS_ALIVE   "ssdp:alive"

Definition for NTS alive

MUPNP_NTS_BYEBYE

#define MUPNP_NTS_BYEBYE   "ssdp:byebye"

Definition for NTS byebye

mupnp_nts_isalive

#define mupnp_nts_isalive

(

str

)

Value:

((0 <= mupnp_strstr(str, MUPNP_NTS_ALIVE)) ? true : false)

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

Parameters

str	String to be checked

Returns

True if string is of type "alive", false otherwise

mupnp_nts_isbyebye

#define mupnp_nts_isbyebye

(

str

)

Value:

((0 <= mupnp_strstr(str, MUPNP_NTS_BYEBYE)) ? true : false)

Check if string type is "byebye"

Parameters

str	String to be checked

Returns

True if string is of type "byebye", false othewise

mupnp_nts_ispropchange

#define mupnp_nts_ispropchange

(

str

)

Value:

((0 <= mupnp_strstr(str, MUPNP_NTS_PROPCHANGE)) ? true : false)

Check if string type is "property change"

Parameters

str	String to be checked

Returns

True if string type is "property change"

MUPNP_NTS_PROPCHANGE

#define MUPNP_NTS_PROPCHANGE   "upnp:propchange"

Definition for NTS property change

MUPNP_ST_ALL_DEVICE

#define MUPNP_ST_ALL_DEVICE   "ssdp:all"

Definition for general ST (search target)

mupnp_st_isalldevice

#define mupnp_st_isalldevice

(

str

)

Value:

((0 <= mupnp_strstr(str, MUPNP_ST_ALL_DEVICE)) ? true : false)

Check if device is of type "all"

Parameters

str	String to be checked

Returns

True if device type is "all", false otherwise

mupnp_st_isrootdevice

#define mupnp_st_isrootdevice

(

str

)

Value:

((0 <= mupnp_strstr(str, MUPNP_ST_ROOT_DEVICE)) ? true : false)

Check if device string is from root device

Parameters

str	String to be checked

Returns

True if string is from device type "root device", false otherwise

mupnp_st_isurn

#define mupnp_st_isurn

(

str

)

Value:

((0 <= mupnp_strstr(str, MUPNP_ST_URN)) ? true : false)

Check if string is from urn

Parameters

str	String to be checked

Returns

True if string is from urn, false otherwise

mupnp_st_isurndevice

#define mupnp_st_isurndevice

(

str

)

Value:

((0 <= mupnp_strstr(str, MUPNP_ST_URN_DEVICE)) ? true : false)

Check if string is from urn device

Parameters

str	String to be checked

Returns

True if string is from urn device, false otherwise

mupnp_st_isurnservice

#define mupnp_st_isurnservice

(

str

)

Value:

((0 <= mupnp_strstr(str, MUPNP_ST_URN_SERVICE)) ? true : false)

Check if string is from urn service

Parameters

str	String to be checked

Returns

True if string is from urn service, false otherwise

mupnp_st_isuuiddevice

#define mupnp_st_isuuiddevice

(

str

)

Value:

((0 <= mupnp_strstr(str, MUPNP_ST_UUID_DEVICE)) ? true : false)

Check if string is from uuid device

Parameters

str	String to be checked

Returns

True if string is from uuid device, false otherwise

MUPNP_ST_ROOT_DEVICE

#define MUPNP_ST_ROOT_DEVICE   "upnp:rootdevice"

Definition for root device ST

MUPNP_ST_URN

#define MUPNP_ST_URN   "urn"

Definition for URN device

MUPNP_ST_URN_DEVICE

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

Definition for URN device

MUPNP_ST_URN_SERVICE

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

Definition for URN service

MUPNP_ST_UUID_DEVICE

#define MUPNP_ST_UUID_DEVICE   "uuid"

Definition for ST UUID (universally unique identifier) prefix

mupnp_usn_isrootdevice

#define mupnp_usn_isrootdevice

(

str

)

Value:

((0 <= mupnp_strstr(str, MUPNP_USN_ROOTDEVICE)) ? true : false)

Check if usn is from root device

Parameters

str	String to be checked

Returns

True if usn associates to root device, false otherwise

MUPNP_USN_ROOTDEVICE

#define MUPNP_USN_ROOTDEVICE   "upnp:rootdevice"

Definition for USN rootdevice

Typedef Documentation

mUpnpActionRequest

typedef struct _mUpnpActionRequest mUpnpActionRequest

Data type definition for action request

mUpnpActionResponse

typedef struct _mUpnpActionResponse mUpnpActionResponse

Data type definition for action response

mUpnpQueryRequest

typedef struct _mUpnpQueryRequest mUpnpQueryRequest

Data type definition for query request

mUpnpQueryResponse

typedef struct _mUpnpQueryResponse mUpnpQueryResponse

Data type definition for query response

Function Documentation

mupnp_action_performlistner()

bool mupnp_action_performlistner	(	mUpnpAction *	action,
		mUpnpActionRequest *	actionReq )

Perform action listener

Parameters

action	Action
actionReq	Action request

mupnp_action_post()

bool mupnp_action_post

(

mUpnpAction *

action

)

Send action

Parameters

action

Action

mupnp_control_action_request_clear()

void mupnp_control_action_request_clear

(

mUpnpActionRequest *

actionReq

)

Clear action request

Parameters

actionReq

Clear Action request

mupnp_control_action_request_delete()

void mupnp_control_action_request_delete

(

mUpnpActionRequest *

actionReq

)

Delete action request object

Parameters

actionReq

Action request

mupnp_control_action_request_getactionname()

char * mupnp_control_action_request_getactionname

(

mUpnpActionRequest *

actionReq

)

Get action name from action request

Parameters

actionReq

Action request

Returns

Action name

mupnp_control_action_request_getactionnode()

mUpnpXmlNode * mupnp_control_action_request_getactionnode

(

mUpnpActionRequest *

actionReq

)

Get XML action node from action request

Parameters

actionReq

Returns

Action request XML node

mupnp_control_action_request_new()

mUpnpActionRequest * mupnp_control_action_request_new

(

void

)

Create new action request object

mupnp_control_action_request_post()

mUpnpActionResponse * mupnp_control_action_request_post

(

mUpnpActionRequest *

actionReq

)

Send action request

Parameters

actionReq

Action request

mupnp_control_action_request_setaction()

void mupnp_control_action_request_setaction	(	mUpnpActionRequest *	actionReq,
		mUpnpAction *	action )

Set action to action request

Parameters

actionReq	Action request
action	UPnP action

mupnp_control_action_request_setsoaprequest()

void mupnp_control_action_request_setsoaprequest	(	mUpnpActionRequest *	actionReq,
		mUpnpSoapRequest *	soapReq )

Set soap request associated with action request

Parameters

actionReq	Action request
soapReq	Soap request

mupnp_control_action_response_clear()

void mupnp_control_action_response_clear

(

mUpnpActionResponse *

actionReq

)

Clear action response

Parameters

actionReq

Action response

mupnp_control_action_response_delete()

void mupnp_control_action_response_delete

(

mUpnpActionResponse *

actionReq

)

Delete action response

Parameters

actionReq

Action response

mupnp_control_action_response_getactionresponsenode()

mUpnpXmlNode * mupnp_control_action_response_getactionresponsenode

(

mUpnpActionResponse *

actionRes

)

Get action response XML node from action response

Parameters

actionRes

Action response

Returns

Action response XML node

mupnp_control_action_response_geterror()

bool mupnp_control_action_response_geterror	(	mUpnpActionResponse *	actionRes,
		mUpnpAction *	action )

Get error associated to action response

Todo

Check this out more carefully

Parameters

actionRes	Action response
action	UPnP action

mupnp_control_action_response_getresult()

bool mupnp_control_action_response_getresult	(	mUpnpActionResponse *	actionRes,
		mUpnpAction *	action )

Get result from action response

Todo

Check this out more carefully

Parameters

actionRes	Action response
action	UPnP action

mupnp_control_action_response_new()

mUpnpActionResponse * mupnp_control_action_response_new

(

void

)

Create new action response

mupnp_control_action_response_setresponse()

void mupnp_control_action_response_setresponse	(	mUpnpActionResponse *	actionRes,
		mUpnpAction *	action )

Set action response to action

Parameters

actionRes	Action response
action	UPnP action

mupnp_control_action_response_setsoapresponse()

void mupnp_control_action_response_setsoapresponse	(	mUpnpActionResponse *	actionRes,
		mUpnpSoapResponse *	soapRes )

Set soap response to action response

Parameters

actionRes	Action response
soapRes	Soap reaponse

mupnp_control_query_request_clear()

void mupnp_control_query_request_clear

(

mUpnpQueryRequest *

queryReq

)

Clear query request

Parameters

queryReq

Query request

mupnp_control_query_request_delete()

void mupnp_control_query_request_delete

(

mUpnpQueryRequest *

queryReq

)

Delete query request

Parameters

queryReq

Query request

mupnp_control_query_request_getvarname()

char * mupnp_control_query_request_getvarname

(

mUpnpQueryRequest *

queryReq

)

Get state variable name associated with this query request

Parameters

queryReq

Query request

Returns

State variable variable name

mupnp_control_query_request_getvarnamenode()

mUpnpXmlNode * mupnp_control_query_request_getvarnamenode

(

mUpnpQueryRequest *

queryReq

)

Get state variable XML node

Parameters

queryReq

Returns

State variable XML node

mupnp_control_query_request_new()

mUpnpQueryRequest * mupnp_control_query_request_new

(

void

)

Create new query request object

mupnp_control_query_request_post()

mUpnpQueryResponse * mupnp_control_query_request_post

(

mUpnpQueryRequest *

queryReq

)

Send query request

Parameters

queryReq

Query request

Returns

Query response

mupnp_control_query_request_setsoaprequest()

void mupnp_control_query_request_setsoaprequest	(	mUpnpQueryRequest *	queryReq,
		mUpnpSoapRequest *	soapReq )

Set soap request for query request

Parameters

queryReq	Query request
soapReq	Soap request

mupnp_control_query_request_setstatevariable()

void mupnp_control_query_request_setstatevariable	(	mUpnpQueryRequest *	queryReq,
		mUpnpStateVariable *	statVar )

Set state variable to query request

Parameters

queryReq	Query request
statVar	State variable

mupnp_control_query_response_clear()

void mupnp_control_query_response_clear

(

mUpnpQueryResponse *

queryReq

)

Clear query response

Parameters

queryReq

Query request

mupnp_control_query_response_delete()

void mupnp_control_query_response_delete

(

mUpnpQueryResponse *

queryReq

)

Delete query response

Parameters

queryReq

Query request

mupnp_control_query_response_getreturnnode()

mUpnpXmlNode * mupnp_control_query_response_getreturnnode

(

mUpnpQueryResponse *

queryRes

)

Get XML return node from query response

Parameters

queryRes

Returns

XML return node

mupnp_control_query_response_getreturnvalue()

char * mupnp_control_query_response_getreturnvalue

(

mUpnpQueryResponse *

queryRes

)

Get return valuse from query response

Parameters

queryRes

Query response

Returns

UPnP return value

mupnp_control_query_response_new()

mUpnpQueryResponse * mupnp_control_query_response_new

(

void

)

Create new query response

mupnp_control_query_response_setresponse()

void mupnp_control_query_response_setresponse	(	mUpnpQueryResponse *	queryRes,
		mUpnpStateVariable *	statVar )

Create and set XML response data into query response

Parameters

queryRes	Query response
statVar	State variable

mupnp_control_query_response_setsoapresponse()

void mupnp_control_query_response_setsoapresponse	(	mUpnpQueryResponse *	queryRes,
		mUpnpSoapResponse *	soapRes )

Set soap response for query response

Parameters

queryRes	Query response
soapRes	Soap response

mupnp_control_request_sethostfromservice()

void mupnp_control_request_sethostfromservice	(	mUpnpSoapRequest *	soapReq,
		mUpnpService *	service )

Set host from service

Parameters

soapReq	Soap request
service	UPnP service

mupnp_control_soap_request_initializeenvelopenode()

void mupnp_control_soap_request_initializeenvelopenode

(

mUpnpSoapRequest *

soapReq

)

Initializes soap requests envelope node

Parameters

soapReq

Soap request

mupnp_control_soap_response_createfaultresponsenode()

mUpnpXmlNode * mupnp_control_soap_response_createfaultresponsenode	(	int	errCode,
		char *	errDescr )

mupnp_control_soap_response_initializeenvelopenode()

void mupnp_control_soap_response_initializeenvelopenode

(

mUpnpSoapResponse *

soapRes

)

Initialize soap responses envelope node

Parameters

soapRes

Soap response

mupnp_control_soap_response_setfaultresponse()

void mupnp_control_soap_response_setfaultresponse	(	mUpnpSoapResponse *	soapRes,
		int	errCode,
		char *	errDescr )

Set failed response data

Parameters

soapRes	Soap response
errCode	Error code
errDescr	Error description

mupnp_statevariable_performlistner()

bool mupnp_statevariable_performlistner	(	mUpnpStateVariable *	statVar,
		mUpnpQueryRequest *	queryReq )

Perform query listener

Parameters

statVar	State variable
queryReq	Query request

mupnp_statevariable_post()

bool mupnp_statevariable_post

(

mUpnpStateVariable *

statVar

)

Send query

Parameters

statVar

State variable

mupnp_usn_getudn()

const char * mupnp_usn_getudn	(	const char *	usn,
		char *	udnBuf,
		size_t	udnBufLen )

Get udn from usn

Parameters

usn	Universal serial number
udnBuf	Buffer where udn is stored after successfull execution
udnBufLen	Buffer length for udnBuf

Returns

Pointer to beginning of udnBuf.