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

Request object for the NodeIdLookupFlow. More...

#include <IfCan.hxx>

Public Member Functions

void reset (Node *node, NodeHandle handle)
 Requests a NodeHandle to be canonicalized, i.e.
 

Public Attributes

NodesrcNode
 Caller node (in order to talk to the bus)
 
NodeHandle handle
 Destination node handle to canonicalize.
 
BarrierNotifiable done
 Needed for receiveing replies by the customer.
 
int resultCode
 Set to 0 on success, or an OpenLCB or OpenMRN error code in case of a failure.
 

Detailed Description

Request object for the NodeIdLookupFlow.

Definition at line 178 of file IfCan.hxx.

Member Function Documentation

◆ reset()

void openlcb::NodeCanonicalizeRequest::reset ( Node node,
NodeHandle  handle 
)
inline

Requests a NodeHandle to be canonicalized, i.e.

look up node ID from alias.

Definition at line 182 of file IfCan.hxx.

Member Data Documentation

◆ done

BarrierNotifiable openlcb::NodeCanonicalizeRequest::done

Needed for receiveing replies by the customer.

Definition at line 197 of file IfCan.hxx.

◆ handle

NodeHandle openlcb::NodeCanonicalizeRequest::handle

Destination node handle to canonicalize.

At request time the alias should vbe filled in; at response time the id will be filled in as well.

Definition at line 194 of file IfCan.hxx.

◆ resultCode

int openlcb::NodeCanonicalizeRequest::resultCode

Set to 0 on success, or an OpenLCB or OpenMRN error code in case of a failure.

Definition at line 200 of file IfCan.hxx.

◆ srcNode

Node* openlcb::NodeCanonicalizeRequest::srcNode

Caller node (in order to talk to the bus)

Definition at line 190 of file IfCan.hxx.


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