PLT_UPnP Class Reference

The PLT_UPnP class maintains a list of devices (PLT_DeviceHost) to advertise and/or control points (PLT_CtrlPoint). More...

#include <PltUPnP.h>

Public Member Functions
	PLT_UPnP ()
	Create a UPnP instance.
NPT_Result	AddDevice (PLT_DeviceHostReference &device)
	Add and start a device inside this UPnP context. More...
NPT_Result	AddCtrlPoint (PLT_CtrlPointReference &ctrlpoint)
	Add and start a control point inside this UPnP context. More...
NPT_Result	RemoveDevice (PLT_DeviceHostReference &device)
	Remove an existing device from this UPnP context. More...
NPT_Result	RemoveCtrlPoint (PLT_CtrlPointReference &ctrlpoint)
	Remove an existing control point from this UPnP context. More...
NPT_Result	Start ()
	Start the UPnP context and all existing devices and control points associated with it.
NPT_Result	Stop ()
	Stop the UPnP context and all existing devices and control points associated with it.
bool	IsRunning ()
	Return the UPnP Engine state. More...
void	SetIgnoreLocalUUIDs (bool ignore)
	When a device and a control point are added to the same UPnP context, it is desired that the device be not discovered by the control point. More...

Detailed Description

The PLT_UPnP class maintains a list of devices (PLT_DeviceHost) to advertise and/or control points (PLT_CtrlPoint).

Member Function Documentation

AddCtrlPoint()

NPT_Result PLT_UPnP::AddCtrlPoint

(

PLT_CtrlPointReference &

ctrlpoint

)

Add and start a control point inside this UPnP context.

Parameters

ctrlpoint

control point to start.

AddDevice()

NPT_Result PLT_UPnP::AddDevice

(

PLT_DeviceHostReference &

device

)

Add and start a device inside this UPnP context.

Parameters

device

device to start.

IsRunning()

bool PLT_UPnP::IsRunning ( )

inline

Return the UPnP Engine state.

Returns

True if the UPnP engine is running.

RemoveCtrlPoint()

NPT_Result PLT_UPnP::RemoveCtrlPoint

(

PLT_CtrlPointReference &

ctrlpoint

)

Remove an existing control point from this UPnP context.

Parameters

ctrlpoint

control point to stop.

RemoveDevice()

NPT_Result PLT_UPnP::RemoveDevice

(

PLT_DeviceHostReference &

device

)

Remove an existing device from this UPnP context.

Parameters

device

device to stop.

SetIgnoreLocalUUIDs()

void PLT_UPnP::SetIgnoreLocalUUIDs ( bool  ignore )

inline

When a device and a control point are added to the same UPnP context, it is desired that the device be not discovered by the control point.

For example when creating a combo UPnP Renderer/CtrlPoint. This methods tells the control point to ignore devices associated with the same UPnP context.

Parameters

ignore

boolean to ignore devices in context

---

The documentation for this class was generated from the following files:

• lib/libUPnP/Platinum/Source/Core/PltUPnP.h
• lib/libUPnP/Platinum/Source/Core/PltUPnP.cpp