subscriber.h File Reference

#include <mupnp/typedef.h>
#include <mupnp/util/list.h>
#include <mupnp/util/string.h>
#include <mupnp/net/url.h>
#include <mupnp/util/time.h>
#include <mupnp/statevariable.h>

Data Structures
struct	_mUpnpSubscriber

Macros
#define	mupnp_subscriber_next(sub)
#define	mupnp_subscriber_remove(sub)
#define	mupnp_subscriber_setsid(sub, value)
#define	mupnp_subscriber_getsid(sub)
#define	mupnp_subscriber_settimeout(sub, value)
#define	mupnp_subscriber_gettimeout(sub)
#define	mupnp_subscriber_setsubscriptiontime(sub, value)
#define	mupnp_subscriber_getsubscriptiontime(sub)
#define	mupnp_subscriber_setnotifycount(sub, value)
#define	mupnp_subscriber_getnotifycount(sub)
#define	mupnp_subscriber_setdeliveryurl(sub, value)
#define	mupnp_subscriber_getdeliveryhost(sub)
#define	mupnp_subscriber_getdeliverypath(sub)
#define	mupnp_subscriber_getdeliveryport(sub)
#define	mupnp_subscriberlist_clear(subList)
#define	mupnp_subscriberlist_size(subList)
#define	mupnp_subscriberlist_gets(subList)
#define	mupnp_subscriberlist_add(subList, sub)

Typedefs
typedef struct _mUpnpSubscriber	mUpnpSubscriber
typedef struct _mUpnpSubscriber	mUpnpSubscriberList

Functions
mUpnpSubscriber *	mupnp_subscriber_new (void)
void	mupnp_subscriber_delete (mUpnpSubscriber *sub)
void	mupnp_subscriber_clear (mUpnpSubscriber *sub)
void	mupnp_subscriber_renew (mUpnpSubscriber *sub)
long	mupnp_subscriber_incrementnotifycount (mUpnpSubscriber *sub)
bool	mupnp_subscriber_isexpired (mUpnpSubscriber *sub)
bool	mupnp_subscriber_notify (mUpnpSubscriber *sub, mUpnpStateVariable *statVar)
bool	mupnp_subscriber_notifyall (mUpnpSubscriber *sub, void *service)
mUpnpSubscriberList *	mupnp_subscriberlist_new (void)
void	mupnp_subscriberlist_delete (mUpnpSubscriberList *subscriberlist)

Macro Definition Documentation

mupnp_subscriber_getdeliveryhost

#define mupnp_subscriber_getdeliveryhost

(

sub

)

Value:

mupnp_net_url_gethost(sub->deliveryURL)

Set the subscriber's delivery host

Parameters

sub	The event subscriber

mupnp_subscriber_getdeliverypath

#define mupnp_subscriber_getdeliverypath

(

sub

)

Value:

mupnp_net_url_getpath(sub->deliveryURL)

Set the subscriber's delivery path

Parameters

sub	The event subscriber

mupnp_subscriber_getdeliveryport

#define mupnp_subscriber_getdeliveryport

(

sub

)

Value:

mupnp_net_url_getport(sub->deliveryURL)

Set the subscriber's delivery port

Parameters

sub	The event subscriber

mupnp_subscriber_getnotifycount

#define mupnp_subscriber_getnotifycount

(

sub

)

Value:

(sub->notifyCount)

Get the notify count

Parameters

sub	The event subscriber

Returns

Notify count

mupnp_subscriber_getsid

#define mupnp_subscriber_getsid

(

sub

)

Value:

mupnp_string_getvalue(sub->sid)

Get the subscriber's SID (Subscription IDentifier) value

Parameters

sub	The current event subscriber

Returns

Subscriber's SID

mupnp_subscriber_getsubscriptiontime

#define mupnp_subscriber_getsubscriptiontime

(

sub

)

Value:

(sub->subscriptionTime)

Get the subscription time (duration)

Parameters

sub	The event subscriber

Returns

Subscription time

mupnp_subscriber_gettimeout

#define mupnp_subscriber_gettimeout

(

sub

)

Value:

(sub->timeout)

Get the subscription timeout (expiration time)

Parameters

sub	The event subscriber

Returns

Timeout

mupnp_subscriber_next

#define mupnp_subscriber_next

(

sub

)

Value:

(mUpnpSubscriber*) mupnp_list_next((mUpnpList*)sub)

Get the next subscriber in a subscriber list. Use as an iterator.

Parameters

sub	The current event subscriber

Returns

Next subscriber or NULL

mupnp_subscriber_remove

#define mupnp_subscriber_remove

(

sub

)

Value:

mupnp_list_remove((mUpnpList*)sub)

Remove the event subscriber from a subscriber list.

Parameters

sub	The event subscriber to remove

mupnp_subscriber_setdeliveryurl

#define mupnp_subscriber_setdeliveryurl	(		sub,
			value )

Value:

mupnp_net_url_set(sub->deliveryURL, value)

Set the subscriber's delivery URL

Parameters

sub	The event subscriber
value	The delivery URL

mupnp_subscriber_setnotifycount

#define mupnp_subscriber_setnotifycount	(		sub,
			value )

Value:

(sub->notifyCount = value)

Set the notify count to a certain value.

Parameters

sub	The event subscriber
value	Notify count

mupnp_subscriber_setsid

#define mupnp_subscriber_setsid	(		sub,
			value )

Value:

mupnp_string_setvalue(sub->sid, value)

Set the subscriber's SID (Subscription IDentifier) value

Parameters

sub	The event subscriber
value	The SID value

mupnp_subscriber_setsubscriptiontime

#define mupnp_subscriber_setsubscriptiontime	(		sub,
			value )

Value:

(sub->subscriptionTime = value)

Set the subscription time (duration) to a certain value.

Parameters

sub	The event subscriber
value	Subscription time

mupnp_subscriber_settimeout

#define mupnp_subscriber_settimeout	(		sub,
			value )

Value:

(sub->timeout = value)

Set the subscription timeout (expiration time) to a certain value.

Parameters

sub	The event subscriber
value	Timeout

mupnp_subscriberlist_add

#define mupnp_subscriberlist_add	(		subList,
			sub )

Value:

mupnp_list_add((mUpnpList*)subList, (mUpnpList*)sub)

Add a new event subscriber to a subscriber list

Parameters

subList	The subscriber list to add to
sub	The subscriber to add

mupnp_subscriberlist_clear

#define mupnp_subscriberlist_clear

(

subList

)

Value:

mupnp_list_clear((mUpnpList*)subList, (MUPNP_LIST_DESTRUCTORFUNC)mupnp_subscriber_delete)

Clear the contents of a subscriber list

Parameters

subList

The subscriber list to clear

mupnp_subscriberlist_gets

#define mupnp_subscriberlist_gets

(

subList

)

Value:

(mUpnpSubscriber*) mupnp_list_next((mUpnpList*)subList)

Get the first item in a subscriber list (use as the first step in iteration).

Parameters

subList

The subscriber list to evaluate

mupnp_subscriberlist_size

#define mupnp_subscriberlist_size

(

subList

)

Value:

mupnp_list_size((mUpnpList*)subList)

Get the size (node count) of a subscriber list

Parameters

subList

The subscriber list to evaluate

Typedef Documentation

mUpnpSubscriber

typedef struct _mUpnpSubscriber mUpnpSubscriber

The device-side structure for an event subscriber

mUpnpSubscriberList

typedef struct _mUpnpSubscriber mUpnpSubscriberList

Function Documentation

mupnp_subscriber_clear()

void mupnp_subscriber_clear

(

mUpnpSubscriber *

sub

)

Clear the contents of an event subscriber

Todo

Lacks implementation (is it necessary?)

Parameters

sub	The event subscriber

Clear the contents of an event subscriber

Todo

Lacks implementation (is it necessary?)

Parameters

sub	The event subscriber

mupnp_subscriber_delete()

void mupnp_subscriber_delete

(

mUpnpSubscriber *

sub

)

Destroy an event subscriber

Parameters

sub	The event subscriber

mupnp_subscriber_incrementnotifycount()

long mupnp_subscriber_incrementnotifycount

(

mUpnpSubscriber *

sub

)

Increment the event notify count by one

Parameters

sub	The event subscriber

Returns

The new notify count

mupnp_subscriber_isexpired()

bool mupnp_subscriber_isexpired

(

mUpnpSubscriber *

sub

)

Check, whether a subscriber's event subscription has been expired

Parameters

sub	The subscriber

Returns

true if the subscription has been expired; otherwise false

mupnp_subscriber_new()

mUpnpSubscriber * mupnp_subscriber_new

(

void

)

Create a new event subscriber

mupnp_subscriber_notify()

bool mupnp_subscriber_notify	(	mUpnpSubscriber *	sub,
		mUpnpStateVariable *	statVar )

Post a notification to an event subscriber. This is called in a device.

Parameters

sub	The event subscriber
statVar	The evented state variable

Returns

true if succesful; otherwise false

mupnp_subscriber_notifyall()

bool mupnp_subscriber_notifyall	(	mUpnpSubscriber *	sub,
		void *	service )

Post a notification to an event subscriber. This is called in a device.

Parameters

sub	The event subscriber
service	The evented service

Returns

true if succesful; otherwise false

mupnp_subscriber_renew()

void mupnp_subscriber_renew

(

mUpnpSubscriber *

sub

)

Renew a subscription. Essentially sets subscription time (duration) to zero and resets notify count (== event key).

Parameters

sub	The event subscriber

mupnp_subscriberlist_delete()

void mupnp_subscriberlist_delete

(

mUpnpSubscriberList *

subscriberlist

)

Destroy an event subscriber list

Parameters

subscriberlist

The list to destroy

mupnp_subscriberlist_new()

mUpnpSubscriberList * mupnp_subscriberlist_new

(

void

)

Create a new event subscriber list