IO::DMX512::Request Class Reference
#include <Request.h>
Inheritance diagram for IO::DMX512::Request:
Collaboration diagram for IO::DMX512::Request:
Public Member Functions | |
Request (Device &device) | |
Device & | getDevice () |
ErrorCode | parseJson (JsonObjectConst json) override |
Fill this request from a JSON description. More... | |
void | getJson (JsonObject json) const override |
Get result of a completed request in JSON format. More... | |
bool | setNode (DevNode node) override |
If nodes are supported, implement this method. More... | |
DevNode | node () const |
bool | setValue (int value) override |
If nodes support values, implement this method. More... | |
int | getValue () const |
void | submit () override |
Submit a request. More... | |
![]() | |
Request (Device &device) | |
Request (const Request &)=delete | |
virtual | ~Request () |
ErrorCode | error () const |
Request error code defaults to 'pending' and is set on completion. More... | |
bool | isPending () const |
String | caption () const |
Get a descriptive caption for this request. More... | |
void | complete (ErrorCode err) |
void | setID (const String &value) |
Request identifiers are optional, useful for tracking remote requests. More... | |
void | setCommand (Command cmd) |
Set the command code. More... | |
void | onComplete (Callback callback) |
Set the request completion callback. More... | |
bool | nodeQuery (DevNode node) |
bool | nodeOff (DevNode node) |
bool | nodeOn (DevNode node) |
bool | nodeToggle (DevNode node) |
virtual DevNode::States | getNodeStates (DevNode node) |
Query node status from response. More... | |
virtual bool | setNodeState (DevNode node, DevNode::State state) |
const CString & | id () const |
Get the request ID, if there is one. More... | |
Command | getCommand () const |
virtual void | handleEvent (Event event) |
Implementations may override this method as required. More... | |
bool | nodeSet (DevNode node, int value) |
For nodes supporting analogue state (e.g. brightness) More... | |
bool | nodeAdjust (DevNode node, int value) |
![]() | |
Request * | getNext () const |
bool | insertAfter (Request *object) |
Iterator | begin () const |
Iterator | end () const |
Iterator | cbegin () const |
Iterator | cend () const |
![]() | |
virtual | ~LinkedObject () |
virtual LinkedObject * | next () const |
bool | insertAfter (LinkedObject *object) |
bool | operator== (const LinkedObject &other) const |
bool | operator!= (const LinkedObject &other) const |
Additional Inherited Members | |
![]() | |
using | OwnedList = OwnedLinkedObjectListTemplate< Request > |
using | Callback = Delegate< void(const Request &request)> |
Per-request callback A request goes through the following states: More... | |
![]() | |
using | Iterator = IteratorTemplate< Request, Request *, Request & > |
using | ConstIterator = IteratorTemplate< const Request, const Request *, const Request & > |
![]() | |
Device & | device |
Constructor & Destructor Documentation
◆ Request()
|
inline |
Member Function Documentation
◆ getDevice()
|
inline |
◆ getJson()
|
overridevirtual |
Get result of a completed request in JSON format.
Reimplemented from IO::Request.
◆ getValue()
|
inline |
◆ node()
|
inline |
◆ parseJson()
|
overridevirtual |
Fill this request from a JSON description.
Reimplemented from IO::Request.
◆ setNode()
|
overridevirtual |
◆ setValue()
|
inlineoverridevirtual |
If nodes support values, implement this method.
Reimplemented from IO::Request.
◆ submit()
|
overridevirtual |
Submit a request.
The request is added to the controller's queue. If the queue is empty, it starts execution immediately. The result of the request is posted to the callback routine.
Reimplemented from IO::Request.
The documentation for this class was generated from the following file: