Result of a successful RPCCon::Connect() that also established cyclic IO. More...

#include <rpcTypes.h>

Collaboration diagram for profinet::rpc::ConnectResult:

Public Member Functions
bool	HasCyclic () const
	Whether cyclic IO was actually established.

Public Attributes
std::array< std::uint8_t, uuidLenght >	arUuid {}
	AR UUID assigned to this connection.

std::uint16_t	sessionKey = 0
	Session key for this connection.

std::uint16_t	inputFrameId = 0
	Frame ID assigned to the input (device -> controller) IOCR.

std::uint16_t	outputFrameId = 0
	Frame ID assigned to the output (controller -> device) IOCR.

std::optional< raw::RawRpcHeader >	header
	The DCE/RPC header.

int	deviceAlarmRef = 0
	Device's local alarm reference, if an AlarmCR was also established.

Detailed Description

Result of a successful RPCCon::Connect() that also established cyclic IO.

Definition at line 401 of file rpcTypes.h.

Member Function Documentation

◆ HasCyclic()

bool profinet::rpc::ConnectResult::HasCyclic ( ) const

inline

Whether cyclic IO was actually established.

Returns: True if either frame ID is nonzero.

Definition at line 423 of file rpcTypes.h.

References inputFrameId, and outputFrameId.

Member Data Documentation

◆ arUuid

std::array<std::uint8_t, uuidLenght> profinet::rpc::ConnectResult::arUuid {}

AR UUID assigned to this connection.

Definition at line 404 of file rpcTypes.h.

Referenced by profinet::rpc::RPCCon::Connect().

◆ deviceAlarmRef

int profinet::rpc::ConnectResult::deviceAlarmRef = 0

Device's local alarm reference, if an AlarmCR was also established.

Definition at line 419 of file rpcTypes.h.

◆ header

std::optional<raw::RawRpcHeader> profinet::rpc::ConnectResult::header

The DCE/RPC header.

Definition at line 416 of file rpcTypes.h.

◆ inputFrameId

std::uint16_t profinet::rpc::ConnectResult::inputFrameId = 0

Frame ID assigned to the input (device -> controller) IOCR.

Definition at line 410 of file rpcTypes.h.

Referenced by HasCyclic(), profinet::device::TEST_F(), profinet::device::TEST_F(), profinet::device::TEST_F(), profinet::device::TEST_F(), and profinet::device::TEST_F().

◆ outputFrameId

std::uint16_t profinet::rpc::ConnectResult::outputFrameId = 0

Frame ID assigned to the output (controller -> device) IOCR.

Definition at line 413 of file rpcTypes.h.

Referenced by HasCyclic().

◆ sessionKey

std::uint16_t profinet::rpc::ConnectResult::sessionKey = 0

Session key for this connection.

Definition at line 407 of file rpcTypes.h.

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

include/profinet/rpcTypes.h

Public Member Functions

Public Attributes