subscription.h File Reference

#include <mupnp/typedef.h>
#include <mupnp/http/http.h>

Macros
#define	mupnp_event_subscription_request_delete(subReq)
#define	mupnp_event_subscription_request_sethost(subReq, ipaddr, port)
#define	mupnp_event_subscription_request_gethost(subReq, value)
#define	mupnp_event_subscription_request_setnt(subReq, value)
#define	mupnp_event_subscription_request_getnt(subReq, value)
#define	mupnp_event_subscription_request_setcallback(subReq, value)
#define	mupnp_event_subscription_request_getcallback(subReq, value)
#define	mupnp_event_subscription_request_setsid(subReq, value)
#define	mupnp_event_subscription_request_getsid(subReq, value)

Functions
mUpnpSubscriptionRequest *	mupnp_event_subscription_request_new (void)
void	mupnp_event_subscription_request_settimeout (mUpnpSubscriptionRequest *subReq, long timeout)
long	mupnp_event_subscription_request_gettimeout (mUpnpSubscriptionRequest *subReq)

Macro Definition Documentation

mupnp_event_subscription_request_delete

#define mupnp_event_subscription_request_delete

(

subReq

)

Value:

mupnp_http_request_delete(subReq)

Delete subscription request

Parameters

subReq

subscription request

mupnp_event_subscription_request_getcallback

#define mupnp_event_subscription_request_getcallback	(		subReq,
			value )

Value:

mupnp_http_request_getheadervalue(subReq, MUPNP_HTTP_CALLBACK)

Get callback url from subscription request

@subReq Subscription request @value Not actually used anywhere

Bug

Value not needed here!

mupnp_event_subscription_request_gethost

#define mupnp_event_subscription_request_gethost	(		subReq,
			value )

Value:

mupnp_http_request_gethost(subReq)

Get host header value from subscription request

Parameters

subReq	Subscription request
value	Not actually used anywhere

Bug

Value not needed here! (It is even processed out from to be compiled code)

mupnp_event_subscription_request_getnt

#define mupnp_event_subscription_request_getnt	(		subReq,
			value )

Value:

mupnp_http_request_getheadervalue(subReq, MUPNP_HTTP_NT)

Get NT from subscription request

Parameters

subReq	Subscription request
value	Not actually used anywhere

Bug

Value not needed here!

mupnp_event_subscription_request_getsid

#define mupnp_event_subscription_request_getsid	(		subReq,
			value )

Value:

mupnp_http_request_getheadervalue(subReq, MUPNP_HTTP_SID)

Get SID from subscription request object

Parameters

subReq	Subscription request
value	Not used

Bug

Value not needed here!

mupnp_event_subscription_request_setcallback

#define mupnp_event_subscription_request_setcallback	(		subReq,
			value )

Value:

mupnp_http_request_setheadervalue(subReq, MUPNP_HTTP_CALLBACK, value)

Set callback URL for eventing

Parameters

subReq

Subscription request @value value String which defines the callback URL

mupnp_event_subscription_request_sethost

#define mupnp_event_subscription_request_sethost	(		subReq,
			ipaddr,
			port )

Value:

mupnp_http_request_sethost(subReq, ipaddr, port)

Set host header value into underlying HTTP packet

Parameters

subReq	Subscription request
ipaddr	Host ip address
port	Host port

mupnp_event_subscription_request_setnt

#define mupnp_event_subscription_request_setnt	(		subReq,
			value )

Value:

mupnp_http_request_setheadervalue(subReq, MUPNP_HTTP_NT, value)

Set NT (Notification type) for subscription request

Parameters

subReq	Subscription request
value	Notification type

mupnp_event_subscription_request_setsid

#define mupnp_event_subscription_request_setsid	(		subReq,
			value )

Value:

mupnp_http_request_setheadervalue(subReq, MUPNP_HTTP_SID, value)

Set SID (Subscription ID) for subscription request

Parameters

subReq	Subscription request
value	SID

Function Documentation

mupnp_event_subscription_request_gettimeout()

long mupnp_event_subscription_request_gettimeout

(

mUpnpSubscriptionRequest *

subReq

)

Get timeout value from subscription request

Parameters

subReq

Subscription request

Returns

Timeout

mupnp_event_subscription_request_new()

mUpnpSubscriptionRequest * mupnp_event_subscription_request_new

(

void

)

Create new subscription request

mupnp_event_subscription_request_settimeout()

void mupnp_event_subscription_request_settimeout	(	mUpnpSubscriptionRequest *	subReq,
		long	timeout )

Set timeout for subscription request

Parameters

subReq	Subscription request
timeout	Timeout

Set timeout for subscription request

Parameters

subReq	Subscription request
timeout	Timeout value for subscription request