Setup of a Basic DLNA Device service. The device registers itself to the network and answers to the DLNA queries and requests. A DLNA device uses UDP, Http, XML and Soap to discover and manage a service, so there is quite some complexity involved: More...

#include <DLNADevice.h>

Inheritance diagram for tiny_dlna::DLNADevice< ClientType >:

[legend]

Public Member Functions
	DLNADevice ()

bool	begin (DLNADeviceInfo &device, IUDPService &udp, IHttpServer &server) override
	start the

ISubscriptionMgrDevice &	getSubscriptionMgr () override
	Get subscription manager for event handling.

void	end () override
	Stops the processing and releases the resources.

bool	loop (int loopAction=RUN_ALL) override

int	loopPublishSubscriptions ()
	Publish pending subscription notifications.

bool	loopServer () override
	Process http server loop.

int	loopUDPMessages ()
	Process incoming UDP and execute scheduled replies.

DLNAServiceInfo &	getService (const char *id) override
	Provide addess to the service information.

DLNAServiceInfo &	getServiceByAbbrev (const char *abbrev) override
	Get Service by subscription ns abbrev.

DLNAServiceInfo *	getServiceByEventPath (const char *requestPath) override

void	addChange (const char serviceAbbrev, std::function< size_t(Print &, void )> changeWriter, void *ref) override
	Record a state variable change for subscription notifications.

DLNADeviceInfo &	getDeviceInfo () override
	Provides the device.

void	setSchedulerActive (bool flag) override
	We can activate/deactivate the scheduler.

bool	isSchedulerActive () override
	Checks if the scheduler is active.

void	setPostAliveRepeatMs (uint32_t ms) override

void	setSubscriptionsActive (bool flag) override
	Enable or disable subscription notifications: call before begin.

bool	isSubscriptionsActive () const override
	Check if subscription notifications are active.

void	setReference (void *ref) override
	Sets a reference pointer that can be used to associate application.

void *	getReference () override
	Gets the reference pointer.

void	logStatus ()

Static Public Member Functions
static void	parseActionRequest (IHttpServer server, const char requestPath, HttpRequestHandlerLine *hl, ActionRequest &action)
	Parses the SOAP content of a DLNA action request.

static size_t	printReplyXML (Print &out, const char replyName, const char serviceId, std::function< size_t(Print &, void )> valuesWriter=nullptr, void ref=nullptr)
	Builds a standard SOAP reply envelope.

static size_t	replyGetProtocolInfo (Print &out, const char source="", const char sink="")

static size_t	replyGetCurrentConnectionIDs (Print &out, const char *ids)

static size_t	replyGetCurrentConnectionInfo (Print &out, const char protocolInfo, const char connectionID, const char *direction)

static bool	handleSubscription (IHttpServer server, const char requestPath, HttpRequestHandlerLine *hl, bool &is_subscribe)
	Static handler for SUBSCRIBE/UNSUBSCRIBE requests on service event URLs.

Protected Member Functions
void	setDeviceInfo (DLNADeviceInfo &device)

void	setSchedulerIntervalMs (uint32_t ms)
	Set scheduler interval in milliseconds.

uint32_t	getSchedulerIntervalMs () const
	Get scheduler interval in milliseconds.

void	setSubscriptionsIntervalMs (uint32_t ms)
	Set subscription publish interval in milliseconds.

uint32_t	getSubscriptionsIntervalMs () const
	Get subscription publish interval in milliseconds.

void	logScheduledStatus (bool runImmediately=false)

bool	setupParser ()

bool	setupScheduler ()
	Schedule PostAlive messages.

bool	validateServiceInfo (const DLNAServiceInfo &service)
	Validates that all required service URLs and callbacks are defined.

virtual bool	setupDLNAServer (IHttpServer &srv)
	set up Web Server to handle Service Addresses

Static Protected Member Functions
static void	deviceXMLCallback (IHttpServer server, const char requestPath, HttpRequestHandlerLine *hl)
	callback to provide device XML

static bool	handleSubscribe (IHttpServer server, const char requestPath, HttpRequestHandlerLine *hl)
	Handle SUBSCRIBE requests.

static bool	handleUnsubscribe (IHttpServer server, const char requestPath, HttpRequestHandlerLine *hl)
	Handle UNSUBSCRIBE requests.

Protected Attributes
bool	is_active = false

bool	is_subscriptions_active = true

uint32_t	post_alive_repeat_ms = 0

Scheduler	scheduler

SubscriptionMgrDevice< ClientType >	subscription_mgr

DLNADeviceRequestParser	parser

DLNADeviceInfo *	p_device_info = nullptr

IUDPService *	p_udp = nullptr

IHttpServer *	p_server = nullptr

uint64_t	scheduler_interval_ms = (uint64_t)DLNA_RUN_SCHEDULER_EVERY_MS

uint64_t	subscriptions_interval_ms

uint64_t	next_scheduler_timeout_ms = 0

uint64_t	next_subscriptions_timeout_ms = 0

void *	reference = nullptr

Detailed Description

template<typename ClientType>
class tiny_dlna::DLNADevice< ClientType >

Setup of a Basic DLNA Device service. The device registers itself to the network and answers to the DLNA queries and requests. A DLNA device uses UDP, Http, XML and Soap to discover and manage a service, so there is quite some complexity involved:

We handle the UDP communication via a Scheduler and a Request Parser
We handle the Http request with the help of the TinyHttp Server
The XML service descriptions can be stored as char arrays in progmem or generated dynamically with the help of the XMLPrinter class.

The template parameter selects the HTTP client implementation (for example WiFiClient) that will be used by all internal helpers; choose the one that matches your platform.

Template Parameters

ClientType Arduino Client implementation used for outbound HTTP traffic (e.g. WiFiClient, EthernetClient).

Author: Phil Schatzmann