Arduino DLNA Server
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
tiny_dlna::ActionRequest Class Reference

Represents a request to invoke a remote DLNA service action. More...

#include <Action.h>

Public Member Functions

 ActionRequest ()=default
 
 ActionRequest (DLNAServiceInfo &srv, const char *act)
 
void addArgument (Argument arg)
 
void addArgument (const char *name, const char *value)
 
const char * getArgumentValue (const char *name)
 
int getArgumentIntValue (const char *name)
 
void clear ()
 
void setAction (const char *act)
 
const char * getAction ()
 
StrgetActionStr ()
 
void setService (DLNAServiceInfo *srv)
 
DLNAServiceInfogetService ()
 
Vector< Argument > & getArguments ()
 
const Vector< Argument > & getArguments () const
 
void setResultCount (int v)
 
int getResultCount () const
 
 operator bool ()
 

Protected Attributes

DLNAServiceInfop_service = nullptr
 
Vector< Argumentarguments
 
int result_count = 0
 
Str action
 

Detailed Description

Represents a request to invoke a remote DLNA service action.

An ActionRequest contains a pointer to the target DLNAServiceInfo, the action name to call and a list of input Argument items. It is used by the control point to serialize and post a SOAP request to the service's control URL.

Constructor & Destructor Documentation

◆ ActionRequest() [1/2]

tiny_dlna::ActionRequest::ActionRequest ( )
default

◆ ActionRequest() [2/2]

tiny_dlna::ActionRequest::ActionRequest ( DLNAServiceInfo srv,
const char *  act 
)
inline

Member Function Documentation

◆ addArgument() [1/2]

void tiny_dlna::ActionRequest::addArgument ( Argument  arg)
inline

◆ addArgument() [2/2]

void tiny_dlna::ActionRequest::addArgument ( const char *  name,
const char *  value 
)
inline

◆ clear()

void tiny_dlna::ActionRequest::clear ( )
inline

◆ getAction()

const char * tiny_dlna::ActionRequest::getAction ( )
inline

◆ getActionStr()

Str & tiny_dlna::ActionRequest::getActionStr ( )
inline

◆ getArgumentIntValue()

int tiny_dlna::ActionRequest::getArgumentIntValue ( const char *  name)
inline

◆ getArguments() [1/2]

Vector< Argument > & tiny_dlna::ActionRequest::getArguments ( )
inline

◆ getArguments() [2/2]

const Vector< Argument > & tiny_dlna::ActionRequest::getArguments ( ) const
inline

◆ getArgumentValue()

const char * tiny_dlna::ActionRequest::getArgumentValue ( const char *  name)
inline

◆ getResultCount()

int tiny_dlna::ActionRequest::getResultCount ( ) const
inline

◆ getService()

DLNAServiceInfo * tiny_dlna::ActionRequest::getService ( )
inline

◆ operator bool()

tiny_dlna::ActionRequest::operator bool ( )
inline

◆ setAction()

void tiny_dlna::ActionRequest::setAction ( const char *  act)
inline

◆ setResultCount()

void tiny_dlna::ActionRequest::setResultCount ( int  v)
inline

◆ setService()

void tiny_dlna::ActionRequest::setService ( DLNAServiceInfo srv)
inline

Member Data Documentation

◆ action

Str tiny_dlna::ActionRequest::action
protected

◆ arguments

Vector<Argument> tiny_dlna::ActionRequest::arguments
protected

◆ p_service

DLNAServiceInfo* tiny_dlna::ActionRequest::p_service = nullptr
protected

◆ result_count

int tiny_dlna::ActionRequest::result_count = 0
protected

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