The PLT_CtrlPoint class implements the base functionality of a UPnP ControlPoint. More...

#include <PltCtrlPoint.h>

Inheritance diagram for PLT_CtrlPoint:

Collaboration diagram for PLT_CtrlPoint:

Public Member Functions
	PLT_CtrlPoint (const char *search_criteria="upnp:rootdevice")

virtual NPT_Result	GetPort (NPT_UInt16 &port)
	Returns the port used by the internal HTTP server for all incoming event notifications. More...

virtual NPT_Result	AddListener (PLT_CtrlPointListener *listener)

virtual NPT_Result	RemoveListener (PLT_CtrlPointListener *listener)

virtual void	IgnoreUUID (const char *uuid)

virtual NPT_Result	Search (const NPT_HttpUrl &url=NPT_HttpUrl("239.255.255.250", 1900, ""), const char target="upnp:rootdevice", NPT_Cardinal mx=5, NPT_TimeInterval frequency=NPT_TimeInterval(50.), NPT_TimeInterval initial_delay=NPT_TimeInterval(0.))

virtual NPT_Result	Discover (const NPT_HttpUrl &url=NPT_HttpUrl("239.255.255.250", 1900, ""), const char target="ssdp:all", NPT_Cardinal mx=5, NPT_TimeInterval frequency=NPT_TimeInterval(50.), NPT_TimeInterval initial_delay=NPT_TimeInterval(0.))

virtual NPT_Result	InspectDevice (const NPT_HttpUrl &location, const char uuid, NPT_TimeInterval leasetime= PLT_Constants::GetInstance().GetDefaultDeviceLease())

virtual NPT_Result	FindActionDesc (PLT_DeviceDataReference &device, const char service_type, const char action_name, PLT_ActionDesc *&action_desc)

virtual NPT_Result	CreateAction (PLT_DeviceDataReference &device, const char service_type, const char action_name, PLT_ActionReference &action)

virtual NPT_Result	InvokeAction (PLT_ActionReference &action, void *userdata=NULL)

virtual NPT_Result	Subscribe (PLT_Service service, bool cancel=false, void userdata=NULL)

NPT_Result	SetupResponse (NPT_HttpRequest &request, const NPT_HttpRequestContext &context, NPT_HttpResponse &response) override

NPT_Result	ProcessSsdpSearchResponse (NPT_Result res, const NPT_HttpRequestContext &context, NPT_HttpResponse *response) override

NPT_Result	OnSsdpPacket (const NPT_HttpRequest &request, const NPT_HttpRequestContext &context) override

Public Member Functions inherited from NPT_HttpRequestHandler
virtual NPT_Result	SendResponseBody (const NPT_HttpRequestContext &context, NPT_HttpResponse &response, NPT_OutputStream &output)
	Override this method if you want to write the body yourself. More...

virtual void	Completed (NPT_Result)
	A notification method called by the server upon completing the processing of a request.

Protected Member Functions
virtual NPT_Result	DecomposeLastChangeVar (NPT_List< PLT_StateVariable *> &vars)

virtual NPT_Result	Start (PLT_SsdpListenTask *task)

virtual NPT_Result	Stop (PLT_SsdpListenTask *task)

virtual NPT_Result	ProcessSsdpNotify (const NPT_HttpRequest &request, const NPT_HttpRequestContext &context)

virtual NPT_Result	ProcessSsdpMessage (const NPT_HttpMessage &message, const NPT_HttpRequestContext &context, NPT_String &uuid)

virtual NPT_Result	ProcessGetDescriptionResponse (NPT_Result res, const NPT_HttpRequest &request, const NPT_HttpRequestContext &context, NPT_HttpResponse *response, NPT_TimeInterval leasetime, NPT_String uuid)

virtual NPT_Result	ProcessGetSCPDResponse (NPT_Result res, const NPT_HttpRequest &request, const NPT_HttpRequestContext &context, NPT_HttpResponse *response, PLT_DeviceDataReference &device)

virtual NPT_Result	ProcessActionResponse (NPT_Result res, const NPT_HttpRequest &request, const NPT_HttpRequestContext &context, NPT_HttpResponse response, PLT_ActionReference &action, void userdata)

virtual NPT_Result	ProcessSubscribeResponse (NPT_Result res, const NPT_HttpRequest &request, const NPT_HttpRequestContext &context, NPT_HttpResponse response, PLT_Service service, void *userdata)

virtual NPT_Result	ProcessHttpNotify (const NPT_HttpRequest &request, const NPT_HttpRequestContext &context, NPT_HttpResponse &response)

virtual NPT_Result	AddDevice (PLT_DeviceDataReference &data)

virtual NPT_Result	RemoveDevice (PLT_DeviceDataReference &data)

Friends
class	NPT_Reference< PLT_CtrlPoint >

class	PLT_UPnP

class	PLT_UPnP_CtrlPointStartIterator

class	PLT_UPnP_CtrlPointStopIterator

class	PLT_EventSubscriberRemoverIterator

class	PLT_CtrlPointGetDescriptionTask

class	PLT_CtrlPointGetSCPDsTask

class	PLT_CtrlPointInvokeActionTask

class	PLT_CtrlPointHouseKeepingTask

class	PLT_CtrlPointSubscribeEventTask

Detailed Description

The PLT_CtrlPoint class implements the base functionality of a UPnP ControlPoint.

It searches and inpects devices, invoke actions on services and subscribes to events.

Member Function Documentation

◆ GetPort()

NPT_Result PLT_CtrlPoint::GetPort ( NPT_UInt16 & port )

virtual

Returns the port used by the internal HTTP server for all incoming event notifications.

Returns: port

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

lib/libUPnP/Platinum/Source/Core/PltCtrlPoint.h
lib/libUPnP/Platinum/Source/Core/PltCtrlPoint.cpp

Public Member Functions

Protected Member Functions

Friends

Detailed Description

Member Function Documentation

◆ GetPort()