UPnP::BaseObject Class Referenceabstract

Objects which hook into the SSDP message stack. More...

#include <BaseObject.h>

Inheritance diagram for UPnP::BaseObject:
Collaboration diagram for UPnP::BaseObject:

Public Member Functions

virtual bool formatMessage (Message &msg, MessageSpec &ms)=0
 Standard fields have been completed. More...
 
virtual void sendMessage (Message &msg, MessageSpec &ms)
 Called by framework to construct then send a message. More...
 
- Public Member Functions inherited from UPnP::LinkedItem
Itemnext () const override
 
LinkedItemgetNext () const
 
- Public Member Functions inherited from UPnP::Item
virtual ~Item ()
 
virtual XML::NodegetDescription (XML::Document &doc, DescType descType) const
 
virtual ItemEnumeratorgetList (unsigned index, String &name)
 
bool operator== (const Item &other) const
 

Detailed Description

Objects which hook into the SSDP message stack.

Member Function Documentation

◆ formatMessage()

virtual bool UPnP::BaseObject::formatMessage ( Message msg,
MessageSpec ms 
)
pure virtual

Standard fields have been completed.

Note
Fields can be modified typically by adding any custom fields before sending response.
Parameters
msgThe message being constructed
msTemplate spec. for message
Return values
boolReturn true to send message, false to cancel

Implemented in UPnP::Service, UPnP::Device, and UPnP::ControlPoint.

◆ sendMessage()

virtual void UPnP::BaseObject::sendMessage ( Message msg,
MessageSpec ms 
)
virtual

Called by framework to construct then send a message.

Parameters
msgMessage to send
msTemplate spec.

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