eip::Connection Class Reference

#include <connection.h>

List of all members.

Public Member Functions
	Connection (const EIP_CONNECTION_INFO_T &o_to_t, const EIP_CONNECTION_INFO_T &t_to_o)
shared_ptr< ForwardCloseRequest >	createForwardCloseRequest ()
shared_ptr< ForwardOpenRequest >	createForwardOpenRequest ()
Path &	getPath ()
void	setConnectionPoints (EIP_USINT origin, EIP_USINT target)
bool	verifyForwardCloseResult (const ForwardCloseSuccess &result)
bool	verifyForwardOpenResult (const ForwardOpenSuccess &result)
Public Attributes
EIP_UINT	connection_sn
EIP_UDINT	o_to_t_api
EIP_UINT	o_to_t_buffer_size
EIP_UDINT	o_to_t_connection_id
EIP_UDINT	o_to_t_rpi
EIP_UDINT	originator_sn
EIP_UINT	originator_vendor_id
EIP_UDINT	t_to_o_api
EIP_UINT	t_to_o_buffer_size
EIP_UDINT	t_to_o_connection_id
EIP_UDINT	t_to_o_rpi
EIP_USINT	timeout_multiplyer
EIP_BYTE	timeout_tick_size
EIP_USINT	timeout_ticks
Private Attributes
Path	path_

---

Detailed Description

Class to encapsulate the EIP concept of a connection.

Definition at line 46 of file connection.h.

---

Constructor & Destructor Documentation

eip::Connection::Connection	(	const EIP_CONNECTION_INFO_T &	o_to_t,
		const EIP_CONNECTION_INFO_T &	t_to_o
	)

Create a connection instance using the directional values and reasonable defaults

Parameters:

o_to_t	Originator to Target info
t_to_o	Target to Originator info

Definition at line 38 of file connection.cpp.

---

Member Function Documentation

shared_ptr< ForwardCloseRequest > eip::Connection::createForwardCloseRequest

(

)

Create a forward close request from the data in this connection object

Definition at line 88 of file connection.cpp.

shared_ptr< ForwardOpenRequest > eip::Connection::createForwardOpenRequest

(

)

Create the forward open request from the data in this connection object

Definition at line 61 of file connection.cpp.

Path& eip::Connection::getPath

(

)

[inline]

Get the path in the given message router request

Returns:

reference to the current Path

Definition at line 80 of file connection.h.

void eip::Connection::setConnectionPoints	(	EIP_USINT	origin,
		EIP_USINT	target
	)

Shortcut to set the path based on connection points

Parameters:

origin	starting connection point
target	ending connection point

Definition at line 52 of file connection.cpp.

bool eip::Connection::verifyForwardCloseResult

(

const ForwardCloseSuccess &

result

)

Verify that the result of a forward close is valid and update accordingly

Returns:

false if there are signficant errors in the result

Definition at line 132 of file connection.cpp.

bool eip::Connection::verifyForwardOpenResult

(

const ForwardOpenSuccess &

result

)

Verify that the result of a forward open is valid and update accordingly

Returns:

false if there are significant errors in the result

Definition at line 105 of file connection.cpp.

---

Member Data Documentation

EIP_UINT eip::Connection::connection_sn

Definition at line 52 of file connection.h.

EIP_UDINT eip::Connection::o_to_t_api

Definition at line 63 of file connection.h.

EIP_UINT eip::Connection::o_to_t_buffer_size

Definition at line 66 of file connection.h.

EIP_UDINT eip::Connection::o_to_t_connection_id

Definition at line 54 of file connection.h.

EIP_UDINT eip::Connection::o_to_t_rpi

Definition at line 61 of file connection.h.

EIP_UDINT eip::Connection::originator_sn

Definition at line 51 of file connection.h.

EIP_UINT eip::Connection::originator_vendor_id

Definition at line 50 of file connection.h.

Path eip::Connection::path_ [private]

Definition at line 115 of file connection.h.

EIP_UDINT eip::Connection::t_to_o_api

Definition at line 64 of file connection.h.

EIP_UINT eip::Connection::t_to_o_buffer_size

Definition at line 67 of file connection.h.

EIP_UDINT eip::Connection::t_to_o_connection_id

Definition at line 55 of file connection.h.

EIP_UDINT eip::Connection::t_to_o_rpi

Definition at line 62 of file connection.h.

EIP_USINT eip::Connection::timeout_multiplyer

Definition at line 59 of file connection.h.

EIP_BYTE eip::Connection::timeout_tick_size

Definition at line 57 of file connection.h.

EIP_USINT eip::Connection::timeout_ticks

Definition at line 58 of file connection.h.

---

The documentation for this class was generated from the following files:

• connection.h
• connection.cpp