RTXI  3.0.0
The Real-Time eXperiment Interface Reference Manual
Public Member Functions | Data Fields
IO::endpoint Struct Reference

#include <io.hpp>

Collaboration diagram for IO::endpoint:
Collaboration graph

Public Member Functions

bool operator== (const endpoint &rhs) const
bool operator!= (const endpoint &rhs) const

Data Fields

IO::Blockblock = nullptr
size_t port = 0
IO::flags_t direction = IO::UNKNOWN

Detailed Description

Structure used to pass information to plugins about a connection.

This structure holds details that identifies a connection end. it is guaranteed to be unique and has comparison functions implemented to allow for ease of equality checks in higher level algorithms

blockPointer to the block object
portThe index of the channel this object represents
directionAn IO::flags_t value stating the direction. possible values are: IO::INPUT, IO::OUTPUT, IO::UNKNOWN (default)
See also

Definition at line 256 of file io.hpp.

Member Function Documentation

◆ operator!=()

bool IO::endpoint::operator!=(const endpointrhs)const

Definition at line 266 of file io.hpp.

Here is the call graph for this function:

◆ operator==()

bool IO::endpoint::operator==(const endpointrhs)const

Definition at line 261 of file io.hpp.

Field Documentation

◆ block

IO::Block* IO::endpoint::block = nullptr

Definition at line 258 of file io.hpp.

◆ direction

IO::flags_t IO::endpoint::direction = IO::UNKNOWN

Definition at line 260 of file io.hpp.

◆ port

size_t IO::endpoint::port = 0

Definition at line 259 of file io.hpp.

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