#include "config.h"
#include "EventSubscribe.h"
#include "gena.h"
#include "httpparser.h"
#include "httpreadwrite.h"
#include "parsetools.h"
#include "statcodes.h"
#include "sysdep.h"
#include "uuid.h"
#include "upnpapi.h"

Include dependency graph for gena_ctrlpt.c:

Functions
static void	GenaAutoRenewSubscription (IN void *input)
	This is a thread function to send the renewal just before the subscription times out. More...

static int	ScheduleGenaAutoRenew (IN int client_handle, IN int TimeOut, IN GenlibClientSubscription *sub)
	Schedules a job to renew the subscription just before time out. More...

static int	gena_unsubscribe (IN const UpnpString url, IN const UpnpString sid, OUT http_parser_t *response)
	Sends the UNSUBCRIBE gena request and recieves the response from the device and returns it as a parameter. More...

static int	gena_subscribe (IN const UpnpString url, INOUT int timeout, IN const UpnpString renewal_sid, OUT UpnpString sid)
	Subscribes or renew subscription. More...

int	genaUnregisterClient (UpnpClient_Handle client_handle)
	Unsubcribes all the outstanding subscriptions and cleans the subscription list. More...

int	genaUnSubscribe (UpnpClient_Handle client_handle, const UpnpString *in_sid)
	Unsubscribes a SID. More...

int	genaSubscribe (UpnpClient_Handle client_handle, const UpnpString PublisherURL, int TimeOut, UpnpString *out_sid)
	This function subscribes to a PublisherURL (also mentioned as EventURL in some places). More...

int	genaRenewSubscription (UpnpClient_Handle client_handle, const UpnpString in_sid, int TimeOut)
	Renews a SID. More...

void	gena_process_notification_event (SOCKINFO info, http_message_t event)
	This function processes NOTIFY events that are sent by devices. More...

Variables
ithread_mutex_t	GlobalClientSubscribeMutex

Function Documentation

◆ gena_process_notification_event()

void gena_process_notification_event	(	SOCKINFO *	info,
		http_message_t *	event
	)

This function processes NOTIFY events that are sent by devices.

Parameters: IN SOCKINFO *info: Socket structure containing the device socket information IN http_message_t *event: The http message contains the GENA notification

Note: called by genacallback()

Parameters

[in]	info	Socket info of the device.
[in]	event	The http message contains the GENA notification.

◆ gena_subscribe()

static int gena_subscribe	(	IN const UpnpString *	url,
		INOUT int *	timeout,
		IN const UpnpString *	renewal_sid,
		OUT UpnpString *	sid
	)

static

Subscribes or renew subscription.

Returns: 0 if successful, otherwise returns the appropriate error code.

Parameters

[in]	url	URL of service to subscribe.
[in,out]	timeout	Subscription time desired (in secs).
[in]	renewal_sid	for renewal, this contains a currently held subscription SID. For first time subscription, this must be NULL.
[out]	sid	SID returned by the subscription or renew msg.

◆ gena_unsubscribe()

static int gena_unsubscribe	(	IN const UpnpString *	url,
		IN const UpnpString *	sid,
		OUT http_parser_t *	response
	)

static

Sends the UNSUBCRIBE gena request and recieves the response from the device and returns it as a parameter.

Returns: 0 if successful, otherwise returns the appropriate error code.

Parameters

[in]	url	Event URL of the service.
[in]	sid	The subcription ID.
[out]	response	The UNSUBCRIBE response from the device.

◆ GenaAutoRenewSubscription()

static void GenaAutoRenewSubscription ( IN void * input )

static

This is a thread function to send the renewal just before the subscription times out.

Parameters

[in] input Thread data(upnp_timeout *) needed to send the renewal.

◆ genaRenewSubscription()

int genaRenewSubscription	(	UpnpClient_Handle	client_handle,
		const UpnpString *	in_sid,
		int *	TimeOut
	)

Renews a SID.

It first validates the SID and client_handle and copies the subscription. It sends RENEW (modified SUBSCRIBE) http request to service and processes the response.

Returns: UPNP_E_SUCCESS if service response is OK, otherwise the appropriate error code.

Parameters

[in]	client_handle	Client handle.
[in]	in_sid	Subscription ID.
[in,out]	TimeOut	requested Duration, if -1, then "infinite". In the OUT case: actual Duration granted by Service, -1 for infinite.

◆ genaSubscribe()

int genaSubscribe	(	UpnpClient_Handle	client_handle,
		const UpnpString *	PublisherURL,
		int *	TimeOut,
		UpnpString *	out_sid
	)

This function subscribes to a PublisherURL (also mentioned as EventURL in some places).

It sends SUBSCRIBE http request to service processes request. Finally adds a Subscription to the clients subscription list, if service responds with OK.

Returns: UPNP_E_SUCCESS if service response is OK, otherwise returns the appropriate error code

Parameters

[in]	client_handle	The client handle.
[in]	PublisherURL	Of the form: "http://134.134.156.80:4000/RedBulb/Event @param[in,out] TimeOut requested Duration: \li if -1, then "infinite". in the OUT case: actual Duration granted by Service, -1 for infinite.
[out]	out_sid	sid of subscription, memory passed in by caller.

◆ genaUnregisterClient()

int genaUnregisterClient ( UpnpClient_Handle client_handle )

Unsubcribes all the outstanding subscriptions and cleans the subscription list.

This function is called when control point unregisters.

Returns: UPNP_E_SUCCESS if successful, otherwise returns the appropriate error code.

Parameters

[in] client_handle Handle containing all the control point related information.

References TRUE, and UPNP_E_SUCCESS.

◆ genaUnSubscribe()

int genaUnSubscribe	(	UpnpClient_Handle	client_handle,
		const UpnpString *	in_sid
	)

Unsubscribes a SID.

It first validates the SID and client_handle,copies the subscription, sends UNSUBSCRIBE http request to service processes request and finally removes the subscription.

Returns: UPNP_E_SUCCESS if service response is OK, otherwise returns the appropriate error code.

Parameters

[in]	client_handle	UPnP client handle.
[in]	in_sid	The subscription ID.

◆ ScheduleGenaAutoRenew()

static int ScheduleGenaAutoRenew	(	IN int	client_handle,
		IN int	TimeOut,
		IN GenlibClientSubscription *	sub
	)

static

Schedules a job to renew the subscription just before time out.

Returns: GENA_E_SUCCESS if successful, otherwise returns the appropriate error code.

Parameters

[in]	client_handle	Handle that also contains the subscription list.
[in]	TimeOut	The time out value of the subscription.
[in]	sub	Subscription being renewed.

Functions

Variables

Function Documentation

◆ gena_process_notification_event()

◆ gena_subscribe()

◆ gena_unsubscribe()

◆ GenaAutoRenewSubscription()

◆ genaRenewSubscription()

◆ genaSubscribe()

◆ genaUnregisterClient()

◆ genaUnSubscribe()

◆ ScheduleGenaAutoRenew()