ccontrolpoint_event.c File Reference

#include <cybergarage/upnp/cupnp_limit.h>
#include <cybergarage/upnp/ccontrolpoint.h>
#include <cybergarage/util/clog.h>

Functions
CgUpnpService *	cg_upnp_device_getfirstexpiratedservice (CgUpnpControlPoint *ctrlPoint, CgUpnpDevice *dev, CgSysTime expirationTime)
void	cg_upnp_controlpoint_expirationhandler (CgThread *thread)
BOOL	cg_upnp_controlpoint_resubscribe (CgUpnpControlPoint *ctrlPoint, CgUpnpService *service, long timeout)
BOOL	cg_upnp_controlpoint_subscribe (CgUpnpControlPoint *ctrlPoint, CgUpnpService *service, long timeout)
BOOL	cg_upnp_controlpoint_unsubscribe (CgUpnpControlPoint *ctrlPoint, CgUpnpService *service)
BOOL	cg_upnp_controlpoint_subscribeall (CgUpnpControlPoint *ctrlPoint, CgUpnpDevice *dev, long timeout)
BOOL	cg_upnp_controlpoint_resubscribeall (CgUpnpControlPoint *ctrlPoint, CgUpnpDevice *dev, long timeout)
BOOL	cg_upnp_controlpoint_unsubscribeall (CgUpnpControlPoint *ctrlPoint, CgUpnpDevice *dev)

---

Function Documentation

void cg_upnp_controlpoint_expirationhandler

(

CgThread *

thread

)

Worker thread for handling expirations.

Parameters:

thread

the thread in question

BOOL cg_upnp_controlpoint_resubscribe	(	CgUpnpControlPoint *	ctrlPoint,
		CgUpnpService *	service,
		long	timeout
	)

Re-subscribe to a service's events (i.e. renew subscription)

Parameters:

	ctrlPoint	The control point in use
	service	The service to subscribe to
	timeout	Timeout for subscription expiration/renewal

Returns:

TRUE if successful; otherwise FALSE

BOOL cg_upnp_controlpoint_resubscribeall	(	CgUpnpControlPoint *	ctrlPoint,
		CgUpnpDevice *	dev,
		long	timeout
	)

Re-subscribe to all of the device's services' events (i.e. renew subscription)

Parameters:

	ctrlPoint	The control point in use
	dev	The device to subscribe to
	timeout	Timeout for subscription expiration/renewal

Returns:

TRUE if successful; otherwise FALSE

BOOL cg_upnp_controlpoint_subscribe	(	CgUpnpControlPoint *	ctrlPoint,
		CgUpnpService *	service,
		long	timeout
	)

Subscribe to a service's events

Parameters:

	ctrlPoint	The control point in use
	service	The service to subscribe to
	timeout	Timeout for subscription expiration/renewal

Returns:

TRUE if successful; otherwise FALSE

BOOL cg_upnp_controlpoint_subscribeall	(	CgUpnpControlPoint *	ctrlPoint,
		CgUpnpDevice *	dev,
		long	timeout
	)

Subscribe to all of the device's services' events

Parameters:

	ctrlPoint	The control point in use
	dev	The device to subscribe to
	timeout	Timeout for subscription expiration/renewal

Returns:

TRUE if successful; otherwise FALSE

BOOL cg_upnp_controlpoint_unsubscribe	(	CgUpnpControlPoint *	ctrlPoint,
		CgUpnpService *	service
	)

Unsubscribe to a service's events (i.e. cancel subscription)

Parameters:

	ctrlPoint	The control point in use
	service	The service to unsubscribe to

Returns:

TRUE if successful; otherwise FALSE

BOOL cg_upnp_controlpoint_unsubscribeall	(	CgUpnpControlPoint *	ctrlPoint,
		CgUpnpDevice *	dev
	)

Unsubscribe to all of the device's services' events (i.e. cancel subscription)

Parameters:

	ctrlPoint	The control point in use
	dev	The device to unsubscribe to

Returns:

TRUE if successful; otherwise FALSE

CgUpnpService* cg_upnp_device_getfirstexpiratedservice	(	CgUpnpControlPoint *	ctrlPoint,
		CgUpnpDevice *	dev,
		CgSysTime	expirationTime
	)

---