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

Represents the result of invoking a DLNA service Action. More...

#include <Action.h>

Public Member Functions

 ActionReply (bool valid=true)
 
bool isValid () const
 
void setValid (bool flag)
 
void add (ActionReply alt)
 
void addArgument (Argument arg)
 
const char * findArgument (const char *name)
 
 operator bool ()
 
int size ()
 
void clear ()
 
void logArguments ()
 

Protected Attributes

Vector< Argumentarguments
 
bool is_valid = true
 

Detailed Description

Represents the result of invoking a DLNA service Action.

An ActionReply collects the returned output arguments of a successful action invocation and carries a validity flag indicating whether the action succeeded. Callers may inspect the reply using the boolean operator or the isValid() accessor. Returned output arguments are stored in the public arguments vector as Argument entries.

Usage:

Note: The class is intentionally small and POD-like to keep embedded footprints minimal.

Constructor & Destructor Documentation

◆ ActionReply()

tiny_dlna::ActionReply::ActionReply ( bool  valid = true)
inline

Member Function Documentation

◆ add()

void tiny_dlna::ActionReply::add ( ActionReply  alt)
inline

◆ addArgument()

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

◆ clear()

void tiny_dlna::ActionReply::clear ( )
inline

◆ findArgument()

const char * tiny_dlna::ActionReply::findArgument ( const char *  name)
inline

◆ isValid()

bool tiny_dlna::ActionReply::isValid ( ) const
inline

◆ logArguments()

void tiny_dlna::ActionReply::logArguments ( )
inline

◆ operator bool()

tiny_dlna::ActionReply::operator bool ( )
inline

◆ setValid()

void tiny_dlna::ActionReply::setValid ( bool  flag)
inline

◆ size()

int tiny_dlna::ActionReply::size ( )
inline

Member Data Documentation

◆ arguments

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

◆ is_valid

bool tiny_dlna::ActionReply::is_valid = true
protected

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