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 | |
Item * | next () const override |
LinkedItem * | getNext () const |
Public Member Functions inherited from UPnP::Item | |
virtual | ~Item () |
virtual XML::Node * | getDescription (XML::Document &doc, DescType descType) const |
virtual ItemEnumerator * | getList (unsigned index, String &name) |
bool | operator== (const Item &other) const |
Detailed Description
Objects which hook into the SSDP message stack.
Member Function Documentation
◆ formatMessage()
|
pure virtual |
Standard fields have been completed.
- Note
- Fields can be modified typically by adding any custom fields before sending response.
- Parameters
-
msg The message being constructed ms Template spec. for message
- Return values
-
bool Return true to send message, false to cancel
Implemented in UPnP::Service, UPnP::Device, and UPnP::ControlPoint.
◆ sendMessage()
|
virtual |
Called by framework to construct then send a message.
- Parameters
-
msg Message to send ms Template spec.
The documentation for this class was generated from the following file: