controlpoint.c File Reference

#include <mupnp/control/control.h>
#include <mupnp/controlpoint.h>
#include <mupnp/net/uri.h>
#include <mupnp/upnp_limit.h>
#include <mupnp/util/log.h>

Functions
static void	mupnp_controlpoint_ssdplistner (mUpnpSSDPPacket *ssdpPkt)
static void	mupnp_controlpoint_ssdpresponselistner (mUpnpSSDPPacket *ssdpPkt)
const char *	mupnp_controlpoint_geteventsubcallbackurl (mUpnpControlPoint *ctrlPoint, char *ifaddr, char *buf, size_t bufLen)
mUpnpControlPoint *	mupnp_controlpoint_new ()
void	mupnp_controlpoint_delete (mUpnpControlPoint *ctrlPoint)
bool	mupnp_controlpoint_start (mUpnpControlPoint *ctrlPoint)
bool	mupnp_controlpoint_stop (mUpnpControlPoint *ctrlPoint)
bool	mupnp_controlpoint_isrunning (mUpnpControlPoint *ctrlPoint)
bool	mupnp_controlpoint_lock (mUpnpControlPoint *ctrlPoint)
bool	mupnp_controlpoint_unlock (mUpnpControlPoint *ctrlPoint)
mUpnpDevice *	mupnp_controlpoint_getdevicebyexacttype (mUpnpControlPoint *ctrlPoint, const char *exacttype)
mUpnpDevice *	mupnp_controlpoint_getdevicebytype (mUpnpControlPoint *ctrlPoint, const char *type)
mUpnpDevice *	mupnp_controlpoint_getdevicebyudn (mUpnpControlPoint *ctrlPoint, const char *udn)
bool	mupnp_controlpoint_parsescservicescpd (mUpnpService *service)
bool	mupnp_controlpoint_parseservicesfordevice (mUpnpDevice *dev, mUpnpSSDPPacket *ssdpPkt)
static mUpnpDevice *	mupnp_controlpoint_createdevicefromssdkpacket (mUpnpSSDPPacket *ssdpPkt)
void	mupnp_controlpoint_adddevicebyssdppacket (mUpnpControlPoint *ctrlPoint, mUpnpSSDPPacket *ssdpPkt)
void	mupnp_controlpoint_removedevicebyssdppacket (mUpnpControlPoint *ctrlPoint, mUpnpSSDPPacket *ssdpPkt)
bool	mupnp_controlpoint_search (mUpnpControlPoint *ctrlPoint, const char *target)
bool	mupnp_controlpoint_ipchanged (mUpnpControlPoint *ctrlPoint)

Function Documentation

mupnp_controlpoint_adddevicebyssdppacket()

void mupnp_controlpoint_adddevicebyssdppacket	(	mUpnpControlPoint *	ctrlPoint,
		mUpnpSSDPPacket *	ssdpPkt )

Add a device on the basis of an SSDP packet. Do not call this from user applications.

Parameters

ctrlPoint	The control point, whose device list to handle
ssdpPkt	The received SSDP packet

mupnp_controlpoint_createdevicefromssdkpacket()

static mUpnpDevice * mupnp_controlpoint_createdevicefromssdkpacket ( mUpnpSSDPPacket * ssdpPkt )

static

mupnp_controlpoint_delete()

void mupnp_controlpoint_delete

(

mUpnpControlPoint *

ctrlPoint

)

Destroy the given control point

Parameters

ctrlPoint

The control point struct to destroy

mupnp_controlpoint_getdevicebyexacttype()

mUpnpDevice * mupnp_controlpoint_getdevicebyexacttype	(	mUpnpControlPoint *	ctrlPoint,
		const char *	exacttype )

Find a device from the control point by the exact type of the device. This function searches for devices, whose complete type string matches the given string, including version number. For example: "urn:schemas-upnp-org:device:FooDevice:1". If you need to disregard the version, use mupnp_controlpoint_getdevicebytype

Parameters

ctrlPoint	Controlpoint in question
exacttype	Type of the device

mupnp_controlpoint_getdevicebytype()

mUpnpDevice * mupnp_controlpoint_getdevicebytype	(	mUpnpControlPoint *	ctrlPoint,
		const char *	type )

Find a device from the controlpoint by the type of the device. This function searches for devices, whose type part (i.e. not including the version) of the device type string matches the given string. For example: "urn:schemas-upnp-org:device:FooDevice". If you need to know the version of a device, use mupnp_devicetype_getversion

Parameters

ctrlPoint	Controlpoint in question
type	Type of the device

mupnp_controlpoint_getdevicebyudn()

mUpnpDevice * mupnp_controlpoint_getdevicebyudn	(	mUpnpControlPoint *	ctrlPoint,
		const char *	udn )

Find a device from the controlpoint by the UDN of the device.

Parameters

ctrlPoint	Controlpoint in question
udn	Type of the device

mupnp_controlpoint_geteventsubcallbackurl()

const char * mupnp_controlpoint_geteventsubcallbackurl	(	mUpnpControlPoint *	ctrlPoint,
		char *	ifaddr,
		char *	buf,
		size_t	bufLen )

Get the event subscription callback URI

Parameters

ctrlPoint	The control point in question
ifaddr	Interface address
buf	Buffer used to store callback url
bufLen	Buffer length

Returns

Event callback url (pointer to buf)

mupnp_controlpoint_ipchanged()

bool mupnp_controlpoint_ipchanged

(

mUpnpControlPoint *

ctrlpoint

)

Notify the control point that any IP of the host has been changed.

Parameters

ctrlpoint

The control point in use

Returns

success of changing used interfaces

mupnp_controlpoint_isrunning()

bool mupnp_controlpoint_isrunning

(

mUpnpControlPoint *

ctrlPoint

)

Check if the control point is activated.

Parameters

ctrlPoint

The control point to stop

Returns

true if running; otherwise false

mupnp_controlpoint_lock()

bool mupnp_controlpoint_lock

(

mUpnpControlPoint *

ctrlPoint

)

Lock the control point's mutex. The control point should be ALWAYS locked, when a mUpnpDevice*, mUpnpService*, mUpnpAction* or other pointer has been taken into use from the stack. This effectively prevents devices/services from being updated/ removed or added while the control point is locked. You should release the lock as soon as possible with mupnp_controlpoint_unlock

Note

Do NOT save any mUpnp* pointers to user-space variables. Use them only as local variables (inside one function) after gaining a mutex lock. Release the lock as soon as you are done accessing the pointer, and then discard the pointer immediately.

Parameters

ctrlPoint

The control point in question

mupnp_controlpoint_new()

mUpnpControlPoint * mupnp_controlpoint_new

(

void

)

Create a new control point. Does not start any threads.

Returns

A newly-created mUpnpControlPoint

mupnp_controlpoint_parsescservicescpd()

bool mupnp_controlpoint_parsescservicescpd

(

mUpnpService *

service

)

Parse the service description from the service's SCPD URL. Do not call this from user applications.

Parameters

service

The service in question

Returns

true if successful; otherwise false

mupnp_controlpoint_parseservicesfordevice()

bool mupnp_controlpoint_parseservicesfordevice	(	mUpnpDevice *	dev,
		mUpnpSSDPPacket *	ssdpPkt )

Parse the device's services using the received SSDP packet. Do not call this from user applications.

Parameters

dev	The device in question
ssdpPkt	An SSDP packet

mupnp_controlpoint_removedevicebyssdppacket()

void mupnp_controlpoint_removedevicebyssdppacket	(	mUpnpControlPoint *	ctrlPoint,
		mUpnpSSDPPacket *	ssdpPkt )

Remove a device on the basis of an SSDP packet. Do not call this from user applications.

Parameters

ctrlPoint	The control point, whose device list to handle
ssdpPkt	The received SSDP packet

mupnp_controlpoint_search()

bool mupnp_controlpoint_search	(	mUpnpControlPoint *	ctrlPoint,
		const char *	target )

Do an M-SEARCH to look for devices in the network.

Parameters

ctrlPoint	The control point in question
target	The Search Target parameter (ex. "ssdp:all")

mupnp_controlpoint_ssdplistner()

static void mupnp_controlpoint_ssdplistner ( mUpnpSSDPPacket * ssdpPkt )

static

mupnp_controlpoint_ssdpresponselistner()

static void mupnp_controlpoint_ssdpresponselistner ( mUpnpSSDPPacket * ssdpPkt )

static

mupnp_controlpoint_start()

bool mupnp_controlpoint_start

(

mUpnpControlPoint *

ctrlPoint

)

Activate the control point. Starts listening for SSDP messages etc. You must call this function before you can actually use a control point.

Parameters

ctrlPoint

The control point to start

Returns

true if successful; otherwise false

mupnp_controlpoint_stop()

bool mupnp_controlpoint_stop

(

mUpnpControlPoint *

ctrlPoint

)

Stop the control point. Stops sending/receiveing/responding to any messages.

Parameters

ctrlPoint

The control point to stop

Returns

true if successful; otherwise false

mupnp_controlpoint_unlock()

bool mupnp_controlpoint_unlock

(

mUpnpControlPoint *

ctrlPoint

)

Release a previously locked control point mutex. See mupnp_controlpoint_lock for a more detailed description on the control point locking mechanism.

Parameters

ctrlPoint

The control point in question