mUPnP for C
Macros | Typedefs | Functions
notify.h File Reference
#include <mupnp/typedef.h>
#include <mupnp/soap/soap.h>
#include <mupnp/util/string.h>
#include <mupnp/statevariable.h>
#include <mupnp/event/property.h>
#include <mupnp/event/subscriber.h>

Macros

#define MUPNP_NOTIFY_XMLNS   "e"
 
#define MUPNP_NOTIFY_PROPERTY   "property"
 
#define MUPNP_NOTIFY_PROPERTYSET   "propertyset"
 
#define mupnp_event_notify_request_sethttprequest(notifyReq, httpReq)
 
#define mupnp_event_notify_request_post(notifyReq, host, port)
 
#define mupnp_event_notify_request_getpropertysetnode(notifyReq)
 
#define mupnp_event_notify_request_setpropertylist(notifyReq, value)
 
#define mupnp_event_notify_request_setnt(soapReq, value)
 
#define mupnp_event_notify_request_getnt(soapReq)
 
#define mupnp_event_notify_request_hasnt(soapReq)
 
#define mupnp_event_notify_request_setnts(soapReq, value)
 
#define mupnp_event_notify_request_getnts(soapReq)
 
#define mupnp_event_notify_request_hasnts(soapReq)
 
#define mupnp_event_notify_request_getsid(soapReq)
 
#define mupnp_event_notify_request_hassid(soapReq)
 
#define mupnp_event_notify_request_setseq(soapReq, value)
 
#define mupnp_event_notify_request_getseq(soapReq)
 
#define mupnp_event_notify_response_issuccessful(notifyRes)
 
#define mupnp_event_notify_response_getstatuscode(notifyRes)
 

Typedefs

typedef mUpnpSoapRequest mUpnpNotifyRequest
 
typedef mUpnpSoapResponse mUpnpNotifyResponse
 

Functions

mUpnpNotifyRequest * mupnp_event_notify_request_new (void)
 
void mupnp_event_notify_request_delete (mUpnpNotifyRequest *notifyReq)
 
void mupnp_event_notify_request_clear (mUpnpNotifyRequest *notifyReq)
 
mUpnpPropertyList * mupnp_event_notify_request_getpropertylist (mUpnpNotifyRequest *nofityReq)
 
void mupnp_event_notify_request_setsid (mUpnpNotifyRequest *soapReq, char *sid)
 
bool mupnp_event_notify_request_setpropertysetnode (mUpnpNotifyRequest *notifyReq, mUpnpSubscriber *sub, void *service, mUpnpStateVariable *statVar)
 

Macro Definition Documentation

◆ mupnp_event_notify_request_getnt

#define mupnp_event_notify_request_getnt ( soapReq)
Value:
mupnp_http_packet_getheadervalue((mUpnpHttpPacket*)(soapReq->httpReq), MUPNP_HTTP_NT)
MUPNP_HTTP_NT
#define MUPNP_HTTP_NT
Definition http.h:107
mupnp_http_packet_getheadervalue
const char * mupnp_http_packet_getheadervalue(mUpnpHttpPacket *httpPkt, const char *name)
Definition http_packet.c:179
_mUpnpHttpPacket
Definition http.h:178

Get NT from notification request

Parameters
soapReqNotification request

◆ mupnp_event_notify_request_getnts

#define mupnp_event_notify_request_getnts ( soapReq)
Value:
mupnp_http_packet_getheadervalue((mUpnpHttpPacket*)(soapReq->httpReq), MUPNP_HTTP_NTS)
MUPNP_HTTP_NTS
#define MUPNP_HTTP_NTS
Definition http.h:108

Get NTS from notification request

Parameters
soapReqNotification request

◆ mupnp_event_notify_request_getpropertysetnode

#define mupnp_event_notify_request_getpropertysetnode ( notifyReq)
Value:
mupnp_soap_request_getrootnoode(notifyReq)
mupnp_soap_request_getrootnoode
#define mupnp_soap_request_getrootnoode(soapReq)
Definition soap.h:92

Get root node associated with current Notification request

Parameters
notifyReqNotification request
Returns
XML node

◆ mupnp_event_notify_request_getseq

#define mupnp_event_notify_request_getseq ( soapReq)
Value:
mupnp_http_packet_getheadersizet((mUpnpHttpPacket*)(soapReq->httpReq), MUPNP_HTTP_SEQ)
MUPNP_HTTP_SEQ
#define MUPNP_HTTP_SEQ
Definition http.h:112
mupnp_http_packet_getheadersizet
size_t mupnp_http_packet_getheadersizet(mUpnpHttpPacket *httpPkt, const char *name)
Definition http_packet.c:222

Get sequence number from notification request

Parameters
soapReqNotification request

◆ mupnp_event_notify_request_getsid

#define mupnp_event_notify_request_getsid ( soapReq)
Value:
mupnp_event_subscription_getsid(mupnp_http_packet_getheadervalue((mUpnpHttpPacket*)(soapReq->httpReq), MUPNP_HTTP_SID))
MUPNP_HTTP_SID
#define MUPNP_HTTP_SID
Definition http.h:111
mupnp_event_subscription_getsid
const char * mupnp_event_subscription_getsid(const char *headerValue)
Definition subscription.c:120

Get SID from notification request

Parameters
soapReqNotification request

◆ mupnp_event_notify_request_hasnt

#define mupnp_event_notify_request_hasnt ( soapReq)
Value:
mupnp_http_packet_hasheader((mUpnpHttpPacket*)(soapReq->httpReq), MUPNP_HTTP_NT)
mupnp_http_packet_hasheader
#define mupnp_http_packet_hasheader(httpPkt, name)
Definition http.h:278

◆ mupnp_event_notify_request_hasnts

#define mupnp_event_notify_request_hasnts ( soapReq)
Value:
mupnp_http_packet_hasheader(((mUpnpHttpPacket*)soapReq->httpReq), MUPNP_HTTP_NTS)

◆ mupnp_event_notify_request_hassid

#define mupnp_event_notify_request_hassid ( soapReq)
Value:
mupnp_http_packet_hasheader(((mUpnpHttpPacket*)(soapReq->httpReq)), MUPNP_HTTP_SID)

◆ mupnp_event_notify_request_post

#define mupnp_event_notify_request_post ( notifyReq,
host,
port )
Value:
mupnp_soap_request_post(notifyReq, host, port)
mupnp_soap_request_post
mUpnpSoapResponse * mupnp_soap_request_post(mUpnpSoapRequest *soapReq, const char *ipaddr, int port)
Definition soap_request.c:218

Sends event Notification request to control point

Parameters
notifyReqNotification request
hostHost address
portHost port
Returns
Notify response

◆ mupnp_event_notify_request_sethttprequest

#define mupnp_event_notify_request_sethttprequest ( notifyReq,
httpReq )
Value:
mupnp_soap_request_sethttprequest(notifyReq, httpReq)
mupnp_soap_request_sethttprequest
bool mupnp_soap_request_sethttprequest(mUpnpSoapRequest *soapReq, mUpnpHttpRequest *httpReq)
Definition soap_request.c:168

Set HTTP request for event Notification request

Parameters
notifyReqNotification request
httpReqHTTP request

◆ mupnp_event_notify_request_setnt

#define mupnp_event_notify_request_setnt ( soapReq,
value )
Value:
mupnp_http_packet_setheadervalue((mUpnpHttpPacket*)(soapReq->httpReq), MUPNP_HTTP_NT, value)
mupnp_http_packet_setheadervalue
void mupnp_http_packet_setheadervalue(mUpnpHttpPacket *httpPkt, const char *name, const char *value)
Definition http_packet.c:106

Set NT (Notificatio type) for Notification request

Parameters
soapReqNotification request
valueNotification type

◆ mupnp_event_notify_request_setnts

#define mupnp_event_notify_request_setnts ( soapReq,
value )
Value:
mupnp_http_packet_setheadervalue((mUpnpHttpPacket*)(soapReq->httpReq), MUPNP_HTTP_NTS, value)

Set NTS (Notification sub type) for current Notification request

Parameters
soapReqNotification request
valueNTS

◆ mupnp_event_notify_request_setpropertylist

#define mupnp_event_notify_request_setpropertylist ( notifyReq,
value )
Value:
mupnp_soap_request_setuserdata(notifyReq, value)
mupnp_soap_request_setuserdata
#define mupnp_soap_request_setuserdata(soapReq, value)
Definition soap.h:100

Set property list for Notification request

Parameters
notifyReqNotification request
valueProperty list value

◆ mupnp_event_notify_request_setseq

#define mupnp_event_notify_request_setseq ( soapReq,
value )
Value:
mupnp_http_packet_setheaderlong((mUpnpHttpPacket*)(soapReq->httpReq), MUPNP_HTTP_SEQ, value)
mupnp_http_packet_setheaderlong
void mupnp_http_packet_setheaderlong(mUpnpHttpPacket *httpPkt, const char *name, long value)
Definition http_packet.c:134

Set sequence number for notification request

Parameters
soapReqNotification request
valueSequence number

◆ mupnp_event_notify_response_getstatuscode

#define mupnp_event_notify_response_getstatuscode ( notifyRes)
Value:
mupnp_soap_response_getstatuscode(notifyRes)
mupnp_soap_response_getstatuscode
#define mupnp_soap_response_getstatuscode(soapRes)
Definition soap.h:122

Get the status code of the specified response

Parameters
notifyResNotification response

◆ mupnp_event_notify_response_issuccessful

#define mupnp_event_notify_response_issuccessful ( notifyRes)
Value:
mupnp_soap_response_issuccessful(notifyRes)
mupnp_soap_response_issuccessful
#define mupnp_soap_response_issuccessful(soapRes)
Definition soap.h:123

Check if notification response was successfull

Parameters
notifyResNotification response

◆ MUPNP_NOTIFY_PROPERTY

#define MUPNP_NOTIFY_PROPERTY   "property"

Define for notify property

◆ MUPNP_NOTIFY_PROPERTYSET

#define MUPNP_NOTIFY_PROPERTYSET   "propertyset"

Define for notify property set

◆ MUPNP_NOTIFY_XMLNS

#define MUPNP_NOTIFY_XMLNS   "e"

Define for XML namespace

Typedef Documentation

◆ mUpnpNotifyRequest

typedef mUpnpSoapRequest mUpnpNotifyRequest

Data type for UPnP Notification request

◆ mUpnpNotifyResponse

typedef mUpnpSoapResponse mUpnpNotifyResponse

Data type for UPnP notify response

Function Documentation

◆ mupnp_event_notify_request_clear()

void mupnp_event_notify_request_clear ( mUpnpNotifyRequest * notifyReq)

Clear Notification request

Parameters
notifyReqNotification request

◆ mupnp_event_notify_request_delete()

void mupnp_event_notify_request_delete ( mUpnpNotifyRequest * notifyReq)

Delete Notification request

Parameters
notifyReqNotification request

◆ mupnp_event_notify_request_getpropertylist()

mUpnpPropertyList * mupnp_event_notify_request_getpropertylist ( mUpnpNotifyRequest * nofityReq)

Get property list from Notification request

Parameters
nofityReqNotification request

◆ mupnp_event_notify_request_new()

mUpnpNotifyRequest * mupnp_event_notify_request_new ( void )

Create new Notification request

◆ mupnp_event_notify_request_setpropertysetnode()

bool mupnp_event_notify_request_setpropertysetnode ( mUpnpNotifyRequest * notifyReq,
mUpnpSubscriber * sub,
void * service,
mUpnpStateVariable * statVar )
Todo
Check what this does exactly...

◆ mupnp_event_notify_request_setsid()

void mupnp_event_notify_request_setsid ( mUpnpNotifyRequest * soapReq,
char * sid )

Set SID (Subscription ID) for notification request

Parameters
soapReqNotification request
sidSID