UPnP::Object Class Reference

#include <Object.h>

Inheritance diagram for UPnP::Object:

Collaboration diagram for UPnP::Object:

Public Types
using	Version = ObjectClass::Version

Public Member Functions
virtual const ObjectClass &	getClass () const =0
Object *	getNext () const
bool	typeIs (const Urn &objectType) const
bool	typeIs (const String &objectType) const
bool	typeIs (const ObjectClass &objectClass) const
virtual Urn	objectType () const
virtual Version	version () const
virtual void	search (const SearchFilter &filter)=0
	Called during SSDP search operation. More...
virtual bool	onHttpRequest (HttpServerConnection &connection)
	Called by framework to handle an incoming HTTP request. More...
virtual IDataSourceStream *	createDescription ()
	Called by framework to construct a device description response stream. More...
Public Member Functions inherited from UPnP::BaseObject
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

Member Typedef Documentation

Version

using UPnP::Object::Version = ObjectClass::Version

Member Function Documentation

createDescription()

virtual IDataSourceStream* UPnP::Object::createDescription ( )

inlinevirtual

Called by framework to construct a device description response stream.

Return values

IDataSourceStream*

The XML description content

By default, the framework generates a stream constructed from the device information fields, but this method may be overridden if, for example, a fixed description is stored in an .xml file.

Reimplemented in UPnP::Service, and UPnP::Device.

getClass()

virtual const ObjectClass& UPnP::Object::getClass ( ) const

pure virtual

Implemented in Dial::Client.

getNext()

Object* UPnP::Object::getNext ( ) const

inline

objectType()

virtual Urn UPnP::Object::objectType ( ) const

inlinevirtual

Reimplemented in UPnP::Service, and UPnP::Device.

onHttpRequest()

virtual bool UPnP::Object::onHttpRequest ( HttpServerConnection &  connection )

inlinevirtual

Called by framework to handle an incoming HTTP request.

Parameters

connection
request
response

Return values

bool	true if request was handled

Reimplemented in UPnP::Service, and UPnP::Device.

search()

virtual void UPnP::Object::search ( const SearchFilter &  filter )

pure virtual

Called during SSDP search operation.

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

typeIs() [1/3]

bool UPnP::Object::typeIs ( const ObjectClass &  objectClass ) const

inline

typeIs() [2/3]

bool UPnP::Object::typeIs ( const String &  objectType ) const

inline

typeIs() [3/3]

bool UPnP::Object::typeIs ( const Urn &  objectType ) const

inline

version()

virtual Version UPnP::Object::version ( ) const

inlinevirtual

---

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

• Libraries/UPnP/src/include/Network/UPnP/Object.h