Open Model Railroad Network (OpenMRN)
Loading...
Searching...
No Matches
openlcb::SNIPClientRequest Struct Reference

Buffer contents for invoking the SNIP client. More...

#include <SNIPClient.hxx>

Inheritance diagram for openlcb::SNIPClientRequest:
CallableFlowRequestBase

Public Types

enum  { OPERATION_PENDING = 0x20000 , ERROR_REJECTED = 0x200000 , OPENMRN_TIMEOUT = 0x80000 }
 

Public Member Functions

void reset (Node *src, NodeHandle dst)
 Helper function for invoke_subflow.
 
- Public Member Functions inherited from CallableFlowRequestBase
void reset_base ()
 Call this from all instances of reset(...).
 

Public Attributes

Nodesrc_
 Source node where to send the request from.
 
NodeHandle dst_
 Destination node to query.
 
Payload response
 Response payload if successful.
 
- Public Attributes inherited from CallableFlowRequestBase
int resultCode
 If high bits are zero, this is a 16-bit OpenLCB result code.
 
BarrierNotifiable done
 Used internally by the invoke_subflow mechanism of StateFlow to notify the calling flow upon completion.
 

Detailed Description

Buffer contents for invoking the SNIP client.

Definition at line 48 of file SNIPClient.hxx.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Definition at line 61 of file SNIPClient.hxx.

Member Function Documentation

◆ reset()

void openlcb::SNIPClientRequest::reset ( Node src,
NodeHandle  dst 
)
inline

Helper function for invoke_subflow.

Parameters
srcthe openlcb node to call from
dstthe openlcb node to target

Definition at line 53 of file SNIPClient.hxx.

Member Data Documentation

◆ dst_

NodeHandle openlcb::SNIPClientRequest::dst_

Destination node to query.

Definition at line 71 of file SNIPClient.hxx.

◆ response

Payload openlcb::SNIPClientRequest::response

Response payload if successful.

Definition at line 73 of file SNIPClient.hxx.

◆ src_

Node* openlcb::SNIPClientRequest::src_

Source node where to send the request from.

Definition at line 69 of file SNIPClient.hxx.


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