csubscriber.c File Reference

#include <cybergarage/upnp/event/cevent.h>
#include <cybergarage/upnp/event/cnotify.h>
#include <cybergarage/upnp/cupnp_limit.h>
#include <cybergarage/util/clog.h>

Functions
CgUpnpSubscriber *	cg_upnp_subscriber_new ()
void	cg_upnp_subscriber_delete (CgUpnpSubscriber *sub)
void	cg_upnp_subscriber_clear (CgUpnpSubscriber *sub)
void	cg_upnp_subscriber_renew (CgUpnpSubscriber *sub)
long	cg_upnp_subscriber_incrementnotifycount (CgUpnpSubscriber *sub)
BOOL	cg_upnp_subscriber_isexpired (CgUpnpSubscriber *sub)
BOOL	cg_upnp_subscriber_notify (CgUpnpSubscriber *sub, CgUpnpStateVariable *statVar)

---

Function Documentation

void cg_upnp_subscriber_clear

(

CgUpnpSubscriber *

sub

)

Clear the contents of an event subscriber

Todo:

Lacks implementation (is it necessary?)

Parameters:

sub

The event subscriber

void cg_upnp_subscriber_delete

(

CgUpnpSubscriber *

sub

)

Destroy an event subscriber

Parameters:

sub

The event subscriber

long cg_upnp_subscriber_incrementnotifycount

(

CgUpnpSubscriber *

sub

)

Increment the event notify count by one

Parameters:

sub

The event subscriber

Returns:

The new notify count

BOOL cg_upnp_subscriber_isexpired

(

CgUpnpSubscriber *

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

CgUpnpSubscriber* cg_upnp_subscriber_new

(

)

Create a new event subscriber

BOOL cg_upnp_subscriber_notify	(	CgUpnpSubscriber *	sub,
		CgUpnpStateVariable *	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

void cg_upnp_subscriber_renew

(

CgUpnpSubscriber *

sub

)

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

Parameters:

sub

The event subscriber

---