tiny_dlna::DLNADeviceInfo Class Reference

Device Attributes and generation of XML using urn:schemas-upnp-org:device-1-0. We could just return a predefined device xml document, but we provide a dynamic generation of the service xml which should be more memory efficient. Strings are represented as char*, so you can assign values that are stored in ProgMem to mimimize the RAM useage. If you need to keep the values on the heap you can use addString() method. More...

#include <DLNADeviceInfo.h>

Inheritance diagram for tiny_dlna::DLNADeviceInfo:

Collaboration diagram for tiny_dlna::DLNADeviceInfo:

Public Member Functions
	DLNADeviceInfo (bool ok=true)
	~DLNADeviceInfo ()
virtual bool	begin ()
	Override to initialize the device.
void	print (Print &out)
	renderes the device xml
void	setDeviceType (const char *st)
const char *	getDeviceType ()
void	setUDN (const char *id)
	Define the udn uuid.
const char *	getUDN ()
	Provide the udn uuid.
void	setBaseURL (const char *url)
	Defines the base url.
void	setBaseURL (IPAddress ip, int port, const char *path="")
	Defines the base URL.
const char *	getBaseURL ()
	Provides the base url.
Url &	getDeviceURL ()
	This method returns base url/device.xml.
void	setIPAddress (IPAddress address)
	Defines the local IP address.
IPAddress	getIPAddress ()
	Provides the local IP address.
const char *	getIPStr ()
	Provides the local address as string.
void	setNS (const char *ns)
const char *	getNS ()
void	setFriendlyName (const char *name)
const char *	getFriendlyName ()
void	setManufacturer (const char *man)
const char *	getManufacturer ()
void	setManufacturerURL (const char *url)
const char *	getManufacturerURL ()
void	setModelDescription (const char *descr)
const char *	getModelDescription ()
void	setModelName (const char *name)
const char *	getModelName ()
void	setModelNumber (const char *number)
const char *	getModelNumber ()
void	setSerialNumber (const char *sn)
const char *	getSerialNumber ()
void	setUniveralProductCode (const char *upc)
const char *	getUniveralProductCode ()
void	addService (DLNAServiceInfo s)
	Adds a service defintion.
DLNAServiceInfo &	getService (const char *id)
	Finds a service definition by name.
Vector< DLNAServiceInfo > &	getServices ()
void	clear ()
void	clearIcons ()
	Overwrite the default icon.
void	addIcon (Icon icon)
Icon	getIcon (int idx=0)
	operator bool ()
void	updateTimestamp ()
	Update the timestamp.
uint32_t	getTimestamp ()
	Returns the time when this object has been updated.
void	setActive (bool flag)
virtual void	loop ()

Protected Member Functions
virtual void	setupServices (HttpServer &server, IUDPService &udp)
	to be implemented by subclasses
size_t	printRoot ()
size_t	printDevice ()
size_t	printSpecVersion ()
size_t	printServiceList ()
size_t	printService (void *srv)
size_t	printIconList ()
size_t	printIconDlnaInfo (Icon &icon)

Protected Attributes
uint64_t	timestamp = 0
bool	is_active = true
XMLPrinter	xml
Url	device_url
IPAddress	localhost
int	version_major = 1
int	version_minor = 0
const char *	base_url = "http://localhost:9876/dlna"
const char *	udn = "uuid:09349455-2941-4cf7-9847-0dd5ab210e97"
const char *	ns = "xmlns=\"urn:schemas-upnp-org:device-1-0\""
const char *	device_type = nullptr
const char *	friendly_name = nullptr
const char *	manufacturer = nullptr
const char *	manufacturer_url = nullptr
const char *	model_description = nullptr
const char *	model_name = nullptr
const char *	model_url = nullptr
const char *	model_number = nullptr
const char *	serial_number = nullptr
const char *	universal_product_code = nullptr
Icon	icon
Vector< DLNAServiceInfo >	services
Vector< Icon >	icons
Str	url_str

Friends
class	XMLDeviceParser
class	DLNAControlPointMgr
class	DLNADevice

Detailed Description

Device Attributes and generation of XML using urn:schemas-upnp-org:device-1-0. We could just return a predefined device xml document, but we provide a dynamic generation of the service xml which should be more memory efficient. Strings are represented as char*, so you can assign values that are stored in ProgMem to mimimize the RAM useage. If you need to keep the values on the heap you can use addString() method.

Author

Phil Schatzmann

Constructor & Destructor Documentation

DLNADeviceInfo()

tiny_dlna::DLNADeviceInfo::DLNADeviceInfo ( bool  ok = true )

inline

~DLNADeviceInfo()

tiny_dlna::DLNADeviceInfo::~DLNADeviceInfo ( )

inline

Member Function Documentation

addIcon()

void tiny_dlna::DLNADeviceInfo::addIcon ( Icon  icon )

inline

addService()

void tiny_dlna::DLNADeviceInfo::addService ( DLNAServiceInfo  s )

inline

Adds a service defintion.

begin()

virtual bool tiny_dlna::DLNADeviceInfo::begin ( )

inlinevirtual

Override to initialize the device.

clear()

void tiny_dlna::DLNADeviceInfo::clear ( )

inline

clearIcons()

void tiny_dlna::DLNADeviceInfo::clearIcons ( )

inline

Overwrite the default icon.

getBaseURL()

const char * tiny_dlna::DLNADeviceInfo::getBaseURL ( )

inline

Provides the base url.

getDeviceType()

const char * tiny_dlna::DLNADeviceInfo::getDeviceType ( )

inline

getDeviceURL()

Url & tiny_dlna::DLNADeviceInfo::getDeviceURL ( )

inline

This method returns base url/device.xml.

getFriendlyName()

const char * tiny_dlna::DLNADeviceInfo::getFriendlyName ( )

inline

getIcon()

Icon tiny_dlna::DLNADeviceInfo::getIcon ( int  idx = 0 )

inline

getIPAddress()

IPAddress tiny_dlna::DLNADeviceInfo::getIPAddress ( )

inline

Provides the local IP address.

getIPStr()

const char * tiny_dlna::DLNADeviceInfo::getIPStr ( )

inline

Provides the local address as string.

getManufacturer()

const char * tiny_dlna::DLNADeviceInfo::getManufacturer ( )

inline

getManufacturerURL()

const char * tiny_dlna::DLNADeviceInfo::getManufacturerURL ( )

inline

getModelDescription()

const char * tiny_dlna::DLNADeviceInfo::getModelDescription ( )

inline

getModelName()

const char * tiny_dlna::DLNADeviceInfo::getModelName ( )

inline

getModelNumber()

const char * tiny_dlna::DLNADeviceInfo::getModelNumber ( )

inline

getNS()

const char * tiny_dlna::DLNADeviceInfo::getNS ( )

inline

getSerialNumber()

const char * tiny_dlna::DLNADeviceInfo::getSerialNumber ( )

inline

getService()

DLNAServiceInfo & tiny_dlna::DLNADeviceInfo::getService ( const char *  id )

inline

Finds a service definition by name.

getServices()

Vector< DLNAServiceInfo > & tiny_dlna::DLNADeviceInfo::getServices ( )

inline

getTimestamp()

uint32_t tiny_dlna::DLNADeviceInfo::getTimestamp ( )

inline

Returns the time when this object has been updated.

getUDN()

const char * tiny_dlna::DLNADeviceInfo::getUDN ( )

inline

Provide the udn uuid.

getUniveralProductCode()

const char * tiny_dlna::DLNADeviceInfo::getUniveralProductCode ( )

inline

loop()

virtual void tiny_dlna::DLNADeviceInfo::loop ( )

inlinevirtual

operator bool()

tiny_dlna::DLNADeviceInfo::operator bool ( )

inline

print()

void tiny_dlna::DLNADeviceInfo::print ( Print &  out )

inline

renderes the device xml

printDevice()

size_t tiny_dlna::DLNADeviceInfo::printDevice ( )

inlineprotected

printIconDlnaInfo()

size_t tiny_dlna::DLNADeviceInfo::printIconDlnaInfo ( Icon &  icon )

inlineprotected

printIconList()

size_t tiny_dlna::DLNADeviceInfo::printIconList ( )

inlineprotected

printRoot()

size_t tiny_dlna::DLNADeviceInfo::printRoot ( )

inlineprotected

printService()

size_t tiny_dlna::DLNADeviceInfo::printService ( void *  srv )

inlineprotected

printServiceList()

size_t tiny_dlna::DLNADeviceInfo::printServiceList ( )

inlineprotected

printSpecVersion()

size_t tiny_dlna::DLNADeviceInfo::printSpecVersion ( )

inlineprotected

setActive()

void tiny_dlna::DLNADeviceInfo::setActive ( bool  flag )

inline

setBaseURL() [1/2]

void tiny_dlna::DLNADeviceInfo::setBaseURL ( const char *  url )

inline

Defines the base url.

setBaseURL() [2/2]

void tiny_dlna::DLNADeviceInfo::setBaseURL ( IPAddress  ip, int  port, const char *  path = ""  )

inline

Defines the base URL.

setDeviceType()

void tiny_dlna::DLNADeviceInfo::setDeviceType ( const char *  st )

inline

setFriendlyName()

void tiny_dlna::DLNADeviceInfo::setFriendlyName ( const char *  name )

inline

setIPAddress()

void tiny_dlna::DLNADeviceInfo::setIPAddress ( IPAddress  address )

inline

Defines the local IP address.

setManufacturer()

void tiny_dlna::DLNADeviceInfo::setManufacturer ( const char *  man )

inline

setManufacturerURL()

void tiny_dlna::DLNADeviceInfo::setManufacturerURL ( const char *  url )

inline

setModelDescription()

void tiny_dlna::DLNADeviceInfo::setModelDescription ( const char *  descr )

inline

setModelName()

void tiny_dlna::DLNADeviceInfo::setModelName ( const char *  name )

inline

setModelNumber()

void tiny_dlna::DLNADeviceInfo::setModelNumber ( const char *  number )

inline

setNS()

void tiny_dlna::DLNADeviceInfo::setNS ( const char *  ns )

inline

setSerialNumber()

void tiny_dlna::DLNADeviceInfo::setSerialNumber ( const char *  sn )

inline

setUDN()

void tiny_dlna::DLNADeviceInfo::setUDN ( const char *  id )

inline

Define the udn uuid.

setUniveralProductCode()

void tiny_dlna::DLNADeviceInfo::setUniveralProductCode ( const char *  upc )

inline

setupServices()

virtual void tiny_dlna::DLNADeviceInfo::setupServices ( HttpServer &  server, IUDPService &  udp  )

inlineprotectedvirtual

to be implemented by subclasses

Reimplemented in tiny_dlna::MediaRenderer, and tiny_dlna::MediaServer.

updateTimestamp()

void tiny_dlna::DLNADeviceInfo::updateTimestamp ( )

inline

Update the timestamp.

Friends And Related Function Documentation

DLNAControlPointMgr

friend class DLNAControlPointMgr

friend

DLNADevice

friend class DLNADevice

friend

XMLDeviceParser

friend class XMLDeviceParser

friend

Member Data Documentation

base_url

const char* tiny_dlna::DLNADeviceInfo::base_url = "http://localhost:9876/dlna"

protected

device_type

const char* tiny_dlna::DLNADeviceInfo::device_type = nullptr

protected

device_url

Url tiny_dlna::DLNADeviceInfo::device_url

protected

friendly_name

const char* tiny_dlna::DLNADeviceInfo::friendly_name = nullptr

protected

icon

Icon tiny_dlna::DLNADeviceInfo::icon

protected

icons

Vector<Icon> tiny_dlna::DLNADeviceInfo::icons

protected

is_active

bool tiny_dlna::DLNADeviceInfo::is_active = true

protected

localhost

IPAddress tiny_dlna::DLNADeviceInfo::localhost

protected

manufacturer

const char* tiny_dlna::DLNADeviceInfo::manufacturer = nullptr

protected

manufacturer_url

const char* tiny_dlna::DLNADeviceInfo::manufacturer_url = nullptr

protected

model_description

const char* tiny_dlna::DLNADeviceInfo::model_description = nullptr

protected

model_name

const char* tiny_dlna::DLNADeviceInfo::model_name = nullptr

protected

model_number

const char* tiny_dlna::DLNADeviceInfo::model_number = nullptr

protected

model_url

const char* tiny_dlna::DLNADeviceInfo::model_url = nullptr

protected

ns

const char* tiny_dlna::DLNADeviceInfo::ns = "xmlns=\"urn:schemas-upnp-org:device-1-0\""

protected

serial_number

const char* tiny_dlna::DLNADeviceInfo::serial_number = nullptr

protected

services

Vector<DLNAServiceInfo> tiny_dlna::DLNADeviceInfo::services

protected

timestamp

uint64_t tiny_dlna::DLNADeviceInfo::timestamp = 0

protected

udn

const char* tiny_dlna::DLNADeviceInfo::udn = "uuid:09349455-2941-4cf7-9847-0dd5ab210e97"

protected

universal_product_code

const char* tiny_dlna::DLNADeviceInfo::universal_product_code = nullptr

protected

url_str

Str tiny_dlna::DLNADeviceInfo::url_str

protected

version_major

int tiny_dlna::DLNADeviceInfo::version_major = 1

protected

version_minor

int tiny_dlna::DLNADeviceInfo::version_minor = 0

protected

xml

XMLPrinter tiny_dlna::DLNADeviceInfo::xml

protected

---

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

• src/dlna/DLNADeviceInfo.h