tiny_dlna Namespace Reference

Classes
class	ActionReply
	Represents the result of invoking a DLNA service Action. More...
class	ActionRequest
	Represents a request to invoke a remote DLNA service action. More...
class	Allocator
	Memory allocateator which uses malloc. More...
class	AllocatorExt
	Memory allocateator which uses ps_malloc (on the ESP32) and if this fails it resorts to malloc. More...
class	Argument
	DLNA Service: Action Argument. More...
class	ControlPointMediaRenderer
	Helper class to control a MediaRenderer device from a control point. More...
class	ControlPointMediaServer
	Helper class to control/query a MediaServer from a control point. More...
class	DLNAControlPointMgr
	Lightweight DLNA control point manager. More...
class	DLNAControlPointRequestParser
	Translates DLNA UDP Requests to Schedule so that we can schedule a reply. More...
class	DLNADevice
	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...
class	DLNADeviceInfo
	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...
class	DLNADeviceRequestParser
	Translates DLNA UDP Requests to Schedule so that we can schedule a reply. More...
class	DLNAServiceInfo
	Attributes needed for the DLNA Service Definition. More...
struct	EscapingPrint
	Print wrapper that escapes & < > while forwarding to an underlying Print. More...
class	HttpChunkReader
	Http might reply with chunks. So we need to dechunk the data. see https://en.wikipedia.org/wiki/Chunked_transfer_encoding. More...
class	HttpChunkWriter
	Writes the data chunked to the actual client. More...
class	HttpHeader
	In a http request and reply we need to process header Debugrmation. With this API we can define and query the header Information. The individual header lines are stored in a list. This is the common functionality for the HttpRequest and HttpReplyHeader subclasses. More...
struct	HttpHeaderLine
	A individual key - value header line. More...
class	HttpLineReader
	We read a single line. A terminating 0 is added to the string to make it compliant for c string functions. More...
class	HttpParameters
	API for http parameters: key=value&key1=value1. More...
class	HttpReplyHeader
	Reading and Writing of Http Replys. More...
class	HttpRequest
	Simple API to process get, put, post, del http requests I tried to use Arduino HttpClient, but I did not manage to extract the mime type from streaming get requests. More...
class	HttpRequestHandlerLine
	Used to register and process callbacks. More...
class	HttpRequestHeader
	Reading and writing of Http Requests. More...
class	HttpRequestRewrite
	Object which information about the rewrite rule. More...
class	HttpServer
	A Simple Header only implementation of Http Server that allows the registration of callback functions. This is based on the Arduino Server class. More...
class	HttpStreamCopy
	Processing of a single stream to a single client. In the loop we can simply provide individual small chunks until we are done. More...
class	HttpStreamedOutput
	Abstract class for handling streamed output. More...
class	HttpTunnel
	Forwards a request to a destination URL and provides a pointer to the result stream. More...
class	Icon
	Information about the icon. More...
struct	IPAddressAndPort
	IP Adress including Port information. More...
class	IUDPService
	Abstract Interface for UDP API. More...
class	List
	Double linked list. More...
class	LoggerClass
	Logger that writes messages dependent on the log level. More...
struct	MediaItem
	Media item description used to build DIDL-Lite entries. More...
class	MediaRenderer
	MediaRenderer DLNA Device. More...
class	MediaServer
	Minimal Digital Media Server implementation. More...
struct	MimeExtension
	Mapping from file extensions to mime types. More...
class	MSearchReplyCP
	Processing at control point to handle a MSearchReply from the device. More...
class	MSearchReplySchedule
	Answer from device to MSearch request by sending a reply. More...
class	MSearchSchedule
	Send MSearch request. More...
class	Notification
	DLNA notification. More...
class	NotifyReplyCP
	Represents a notification/notify reply scheduled for control-point processing. More...
class	NullPrint
	Class with does not do any output: it can be used to determine the length of the output. More...
class	PostAliveSchedule
	Send out PostAlive messages: Repeated every 5 seconds. More...
class	PostByeSchedule
	Send out ByeBye message. More...
class	PostSubscribe
	Send SUBSCRIBE message via UDP unicast. More...
class	QueueLockFree
	A simple single producer, single consumer lock free queue. More...
struct	RequestData
	Provides information of the received UDP which consists of the (xml) data and the peer address and port. More...
class	RingBuffer
	Implementation of a Simple Circular Buffer. Instead of comparing the position of the read and write pointer in order to figure out if we still have characters available or space left to write we keep track of the actual length which is easier to follow. More...
struct	Schedule
	An individual Schedule (to send out UDP messages) More...
class	Scheduler
	Scheduler which processes all due Schedules (to send out UDP replies) More...
class	Str
	String implementation which keeps the data on the heap. We grow the allocated memory only if the copy source is not fitting. More...
class	StringRegistry
	Make sure that a string is stored only once. More...
class	StrPrint
	Print to a dynamic string. More...
class	StrView
	A simple wrapper to provide string functions on char*. If the underlying char* is a const we do not allow any updates; The ownership of the chr* must be managed externally! More...
struct	Subscription
	Represents a single event subscription for a service. More...
class	SubscriptionMgr
	Manages event subscriptions and notification delivery. More...
class	UDPAsyncService
	Access to UDP functionality: sending and receiving of data using the Async API of the ESP32. More...
class	UDPService
	Access to UDP functionality: sending and receiving of data. More...
class	Url
	URL parser which breaks a full url string up into its individual parts. More...
class	Vector
	Vector implementation which provides the most important methods as defined by std::vector. This class it is quite handy to have and most of the times quite better then dealing with raw c arrays. More...
class	XMLAttributeParser
	Small utility to extract attributes from a start-tag in an XML fragment. More...
class	XMLDeviceParser
	Parses an DLNA device xml string to fill the DLNADevice data structure. More...
struct	XMLNode
	Represents a single XML element. More...
class	XMLParser
	Lightweight streaming XML parser. More...
class	XMLParserPrint
	Helper that implements a Print interface to accumulate XML data and then parse it using XMLParser. More...
struct	XMLPrinter
	Functions to efficiently output XML. XML data contains a lot of redundancy so it is more memory efficient to generate the data instead of using a predefined XML document. More...

Typedefs
typedef void(*	http_callback) (HttpServer *server, const char *requestPath, HttpRequestHandlerLine *hl)
using	DLNAHttpRequest = tiny_dlna::HttpRequest
typedef void(*	web_callback_fn) (HttpServer *server, const char *requestPath, HttpRequestHandlerLine *handlerLine)

Enumerations
enum class	DlnaLogLevel { Debug , Info , Warning , Error }
	Supported log levels. More...
enum class	MediaEvent {   SET_URI , PLAY , PAUSE , STOP ,   SET_VOLUME , SET_MUTE }
	Events emitted by the MediaRenderer to notify the application about playback and rendering control changes. More...
enum	TinyMethodID {   T_UNDEFINED , T_GET , T_HEAD , T_POST ,   T_PUT , T_DELETE , T_TRACE , T_OPTIONS ,   T_CONNECT , T_PATCH , T_SUBSCRIBE }

Variables
LoggerClass	DlnaLogger
DLNAControlPointMgr *	selfDLNAControlPoint = nullptr
constexpr const MimeExtension	defaultMimeTable []
const MimeExtension *	mimeTable
const int	MaxHeaderLineLength = 200
const char *	CONTENT_TYPE = "Content-Type"
const char *	CONTENT_LENGTH = "Content-Length"
const char *	CONNECTION = "Connection"
const char *	CON_CLOSE = "close"
const char *	CON_KEEP_ALIVE = "keep-alive"
const char *	TRANSFER_ENCODING = "Transfer-Encoding"
const char *	CHUNKED = "chunked"
const char *	ACCEPT = "Accept"
const char *	ACCEPT_ALL = "*/*"
const char *	SUCCESS = "Success"
const char *	USER_AGENT = "User-Agent"
const char *	DEFAULT_AGENT
const char *	HOST_C = "Host"
const char *	ACCEPT_ENCODING = "Accept-Encoding"
const char *	IDENTITY = "identity"
const char *	LOCATION = "Location"
const char *	methods []

Typedef Documentation

DLNAHttpRequest

using tiny_dlna::DLNAHttpRequest = typedef tiny_dlna::HttpRequest

http_callback

typedef void(* tiny_dlna::http_callback) (HttpServer *server, const char *requestPath, HttpRequestHandlerLine *hl)

web_callback_fn

typedef void(* tiny_dlna::web_callback_fn) (HttpServer *server, const char *requestPath, HttpRequestHandlerLine *handlerLine)

Enumeration Type Documentation

DlnaLogLevel

enum class tiny_dlna::DlnaLogLevel

strong

Supported log levels.

Enumerator
Debug
Info
Warning
Error

MediaEvent

enum class tiny_dlna::MediaEvent

strong

Events emitted by the MediaRenderer to notify the application about playback and rendering control changes.

The application registers a callback using setMediaEventHandler() and will receive the event along with a reference to the emitting MediaRenderer instance. The handler should query the renderer (for example getCurrentUri(), getVolume(), getMime()) to determine the appropriate action for each event.

Events:

• SET_URI: The renderer received a new URI (use getCurrentUri()).
• PLAY: Start or resume playback of the current URI.
• PAUSE: Pause playback.
• STOP: Stop playback and reset playback state.
• SET_VOLUME: The volume was changed (use getVolume()).
• SET_MUTE: The mute state changed (use isMuted()).

Enumerator
SET_URI
PLAY
PAUSE
STOP
SET_VOLUME
SET_MUTE

TinyMethodID

enum tiny_dlna::TinyMethodID

Enumerator
T_UNDEFINED
T_GET
T_HEAD
T_POST
T_PUT
T_DELETE
T_TRACE
T_OPTIONS
T_CONNECT
T_PATCH
T_SUBSCRIBE

Variable Documentation

ACCEPT

const char* tiny_dlna::ACCEPT = "Accept"

ACCEPT_ALL

const char* tiny_dlna::ACCEPT_ALL = "*/*"

ACCEPT_ENCODING

const char* tiny_dlna::ACCEPT_ENCODING = "Accept-Encoding"

CHUNKED

const char* tiny_dlna::CHUNKED = "chunked"

CON_CLOSE

const char* tiny_dlna::CON_CLOSE = "close"

CON_KEEP_ALIVE

const char* tiny_dlna::CON_KEEP_ALIVE = "keep-alive"

CONNECTION

const char* tiny_dlna::CONNECTION = "Connection"

CONTENT_LENGTH

const char* tiny_dlna::CONTENT_LENGTH = "Content-Length"

CONTENT_TYPE

const char* tiny_dlna::CONTENT_TYPE = "Content-Type"

DEFAULT_AGENT

const char* tiny_dlna::DEFAULT_AGENT

Initial value:

=
    "Mozilla/5.0 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)"

defaultMimeTable

const MimeExtension tiny_dlna::defaultMimeTable

constexpr

Initial value:

= {
    {".htm", "text/html"},       {".css", "text/css"},
    {".xml", "text/xml"},        {".js", "application/javascript"},
    {".png", "image/png"},       {".gif", "image/gif"},
    {".jpeg", "image/jpeg"},     {".ico", "image/x-icon"},
    {".pdf", "application/pdf"}, {".zip", "application/zip"},
    {nullptr, nullptr}}

DlnaLogger

LoggerClass tiny_dlna::DlnaLogger

HOST_C

const char* tiny_dlna::HOST_C = "Host"

IDENTITY

const char* tiny_dlna::IDENTITY = "identity"

LOCATION

const char* tiny_dlna::LOCATION = "Location"

MaxHeaderLineLength

const int tiny_dlna::MaxHeaderLineLength = 200

methods

const char* tiny_dlna::methods[]

Initial value:

= {"?",       "GET",    "HEAD",  "POST",
                         "PUT",     "DELETE", "TRACE", "OPTIONS",
                         "CONNECT", "PATCH", "SUBSCRIBE",  nullptr}

mimeTable

const MimeExtension * tiny_dlna::mimeTable

selfDLNAControlPoint

DLNAControlPointMgr* tiny_dlna::selfDLNAControlPoint = nullptr

SUCCESS

const char* tiny_dlna::SUCCESS = "Success"

TRANSFER_ENCODING

const char* tiny_dlna::TRANSFER_ENCODING = "Transfer-Encoding"

USER_AGENT

const char* tiny_dlna::USER_AGENT = "User-Agent"