Base class for connections to the BAOS device via a TCP connection. More...

#include <baos/ip/BaosTcpConnection.h>

Inheritance diagram for BaosTcpConnection:

Public Types
using	UPtr = std::unique_ptr< BaosTcpConnection >
	Alias for a std::unique_ptr to this class.

using	TcpTransportFrame = Buffer
	Alias on how a TcpTransportFrame is represented.

Public Types inherited from BaosConnection
using	Clock = std::chrono::system_clock
	An alias for the clock internaly used.

using	BaosFrame = Buffer
	An alias for the container type to store frame/packets/telegrams in.

using	BaosFrame_UPtr = std::unique_ptr< BaosFrame >
	An alias for a std::unique_ptr holding a BaosFrame.

using	UPtr = std::unique_ptr< BaosConnection >
	An alias for an unqiue pointer to this class.

using	ConnectionEventCb = std::function< void(ConnectionEvent &)>
	Function signature for connection events callbacks.

using	ServerItemIndicationCb = std::function< void(const protocol::ServerItems &)>
	Function signature for serveritem indication callbacks.

using	DatapointValueCb = std::function< void(const protocol::DatapointValueStates &)>
	Function signature for datapoint value indication callbacks.

Public Member Functions
void	enableEnsureAutoConnect (bool enable)
	Enables the option for ensure auto connect in legacy mode (e.g. 774.1 with auto connect mode). The default value is true (enabled).

void	enableVerifyProtocolVersion (bool enable)
	Enables the option for verify the BAOS binary protocol version. The default value is true (enabled).

void	open (const std::string &ip4Address, std::uint16_t port=12004)
	Open a connection to physical BAOS device.

void	reopen () override
	Reopens the underlying connection, has to be implemented by derived classes.

Public Member Functions inherited from BaosConnection
	BaosConnection ()
	Default constructor.

virtual	~BaosConnection ()
	Default destructor.

void	start ()
	Start the client side of the connection.

void	stop ()
	Stop the client side of the connection.

void	close ()
	Close the connection to the BAOS device.

bool	isOpen ()
	Returns the open state of the connection.

void	setConnectionEventCallback (ConnectionEventCb callback)

void	setServerItemsIndCallback (ServerItemIndicationCb callback)

void	setDatapointValueIndCallback (DatapointValueCb callback)

std::optional< protocol::ServerItem >	getServerItem (protocol::ServerItemId id)
	Get a single the ServerItem.

protocol::ServerItems	getServerItems (std::uint16_t startItem, std::uint16_t numberOfItems)
	Get a list of serveritems from the device.

void	setServerItem (const protocol::ServerItem &serverItem)

void	setServerItem (protocol::ServerItem &&serverItem)

void	setServerItems (protocol::ServerItems &&serverItems)

std::optional< protocol::DatapointDescription >	getDpDescription (std::uint16_t dpId)
	Get the datapoint description for one datapoint.

protocol::DatapointDescriptions	getDpDescriptions (std::uint16_t startDpId, std::uint16_t numberOfItems)
	Get a list of DatapointDescriptions.

std::optional< protocol::DatapointDescriptionString >	getDpDescriptionString (std::uint16_t dpId)
	Get the datapoint description string for one datapoint.

protocol::DatapointDescriptionStrings	getDpDescriptionStrings (std::uint16_t startDpId, std::uint16_t numberOfStrings)
	Get a list of DatapointDescriptionsStrings.

std::optional< std::uint8_t >	getParameterByte (std::uint16_t byteIndex)
	Get a single parameter byte.

protocol::ParameterBytes	getParameterBytes (std::uint16_t byteIndex, std::uint16_t numberOfBytes)
	Get a list of parameter bytes.

std::optional< protocol::DatapointValueState >	getDpValue (std::uint16_t dpId)
	Get a single datapoint value with its associated state.

protocol::DatapointValueStates	getDpValues (std::uint16_t startDpId, std::uint16_t numberOfValues, protocol::DatapointValueFilter filter=protocol::DatapointValueFilter::ALL)
	Get a map with the datapoint id as key and the DatapointValueState as value.

void	setDpValue (std::uint16_t dpId, protocol::DatapointChangeValue &&dpValue)
	Send a SetDatapointValue request to the BAOS device for one datapoint.

void	setDpValues (std::map< std::uint16_t, protocol::DatapointChangeValue > &&dpValues)
	Send a SetDatapointValue request to the BAOS device with given datapoint values.

protocol::ResponseFuture	getServerItemAsync (protocol::ServerItemId id)

protocol::ResponseFuture	getServerItemsAsync (std::uint16_t startItem, std::uint16_t numberOfItems)
	Get a list of serveritems from the device.

protocol::ResponseFuture	setServerItemAsync (protocol::ServerItem &&serverItem)

protocol::ResponseFuture	setServerItemsAsync (protocol::ServerItems &&serverItems)

protocol::ResponseFuture	getDpDescriptionAsync (std::uint16_t dpId)
	Get the datapoint description for one datapoint.

protocol::ResponseFuture	getDpDescriptionsAsync (std::uint16_t startDpId, std::uint16_t numberOfItems)
	Get a list of DatapointDescriptions.

protocol::ResponseFuture	getDpDescriptionStringAsync (std::uint16_t dpId)
	Get the datapoint description string for one datapoint.

protocol::ResponseFuture	getDpDescriptionStringsAsync (std::uint16_t startDpId, std::uint16_t numberOfStrings)
	Get a list of DatapointDescriptionsStrings.

protocol::ResponseFuture	getParameterByteAsync (std::uint16_t byteIndex)
	Get a single parameter byte.

protocol::ResponseFuture	getParameterBytesAsync (std::uint16_t byteIndex, std::uint16_t numberOfBytes)
	Get a list of parameter bytes.

protocol::ResponseFuture	getDpValueAsync (std::uint16_t dpId)
	Get a single datapoint value with its associated state.

protocol::ResponseFuture	getDpValuesAsync (std::uint16_t startDpId, std::uint16_t numberOfValues, protocol::DatapointValueFilter filter=protocol::DatapointValueFilter::ALL)
	Get a map with the datapoint id as key and the DatapointValueState as value.

protocol::ResponseFuture	setDpValueAsync (std::uint16_t dpId, protocol::DatapointChangeValue &&dpValue)
	Send a SetDatapointValue request to the BAOS device for one datapoint.

protocol::ResponseFuture	setDpValuesAsync (std::map< std::uint16_t, protocol::DatapointChangeValue > &&dpValues)
	Send a SetDatapointValue request to the BAOS device with given datapoint values.

protocol::ResponseFuture	closeAsync ()
	Close the connection.

Protected Member Functions
virtual void	postOpen (protocol::ResponsePromise &&prom)

bool	isOpenImpl () override
	The implementation function for getting the opened state of the connection.

protocol::ResponseFuture	closeImplAsync () override
	The implementation function for closing a connection.

void	startImpl () override
	The implementation function for starting the connection class.

void	eventHandler ()
	Handles the incoming IOEvents.

void	handleRxTcp (IOEvent &&event)
	Called for every Rx IOEvent (incoming, received)

void	handleTxTcp (IOEvent &&event)
	Called for every Tx IOEvent (outgoing, send, transmit)

protocol::ResponseFuture	sendImpl (BaosFrame &&frame) override
	The implementation function for sending bytes to the connected device.

void	onStateChange (State oldState, State newState) override
	Invoked if the internal connection state should be changed.

void	resolveMsgQPromises (std::exception_ptr eptr) noexcept

transport::TransportTcpIO &	getTransportIO ()

Protected Member Functions inherited from BaosConnection
protocol::ResponseFuture	send (BaosFrame &&frame)
	Sends a generic frame( a byte list) to the BAOS device.

BaosParseStatus	handleBaosFrame (BaosFrame_UPtr &&frame)
	For every received BAOS frame this handler is internally called.

BaosParseStatus	handleBaosIndication (BaosFrame_UPtr &&frame)
	For every received BAOS indication this handler is internally called.

protocol::BaosResponseCode	handleBaosResponse (BaosFrame_UPtr &&frame)
	For every received BAOS response this handler is internally called.

State	setState (State newState)
	Set the internal state of this connections state machine.

State	getState () const
	Get the current internal state of this connections state machine.

protocol::BaosBaseResponse::SPtr	decodeResponse (BaosFrame_UPtr &&frame)
	Decodes the baos response.

virtual void	stopImpl ()
	The implementation function for stopping the connection class.

void	emitConnectionEvent (State oldState, State newState)

void	emitConnectionEvent (ConnectionEvent::Type event)

virtual void	onTimerExpired (std::vector< std::uint64_t > ids)
	Invoked if on of the timers has expired.

ConnectionEvent::Type	getConnectionEvent (State state)

Protected Attributes
transport::TransportTcpIO::UPtr	transportIO_

ip::Ip4SocketAddress	socketAddress_

std::uint64_t	msgId_ {0}

bool	ensureAutoConnect_ {true}

bool	verifyProtocolVersion_ {true}

Protected Attributes inherited from BaosConnection
std::atomic< bool >	shouldStop_ {false}
	Flag to indicate that the connection should stop at the next opportunity.

std::atomic< bool >	isRunning_ {false}
	Keep track if the connection is in running state or stopping / stopped.

wzcpp::ThreadPoolExecutor	executor_ {5}

wzcpp::TimerManager< Clock >	timerManager_
	Manages the timers for this connection.

wzcpp::Timer< Clock >	respTimeoutTimer_
	The actual timer objects for respone timeouts.

wzcpp::Timer< Clock >	heartBeatTimer_
	The actual timer objects for heartbeats.

Buffer	waitResponse_
	While waiting for a response this holds the pattern of the response we expect.

protocol::ResponsePromise	responsePromise_
	If a packet is send out via handleTxTcp the corresponding promise is stored here.

PromiseState	responsePromiseState_ {PromiseState::UNUSED}
	The state of the responsePromise_.

std::uint64_t	currentMessageId_ {0}
	For internal use a unique message id.

std::queue< IOEvent >	txQueue_
	Holds the packets to send waiting to be processed.

BaosMsgQueue	bMsgQ_
	Hold the event for the main connection loop.

BaosIndQueue	bIndQ_
	Holds the indication to be send out to clients.

BaosIndicationSender	indSender_
	Responsible for sending out the indications.

Additional Inherited Members
Protected Types inherited from BaosConnection
enum class	State { RUNNING , STOPPING , STOPPED , CONOPENING , SENDING , SENDCOMPLETE , WAITRESPONSE , IDLE , CONCLOSING , CONERROR , CONCLOSED , CONCLOSED_BY_ERROR , FATALERROR }
	Represents the internal state of this connection. More...

enum class	PromiseState { UNUSED , SET , RESOLVED }
	The asynchronous functions return a promise to keep internal track of their state this enum is used.

Static Protected Member Functions inherited from BaosConnection
static std::string	stateToString (State state)
	Get human readable string from internal state.

Detailed Description

Base class for connections to the BAOS device via a TCP connection.

Member Function Documentation

◆ enableEnsureAutoConnect()

void enableEnsureAutoConnect ( bool enable )

Enables the option for ensure auto connect in legacy mode (e.g. 774.1 with auto connect mode). The default value is true (enabled).

Remarks: Intended for testing only

◆ open()

void open	(	const std::string &	ip4Address,
		std::uint16_t	port = `12004`
	)

Open a connection to physical BAOS device.

Parameters

ip4Address	The IPv4 Address as string in the form "xxx.xxx.xxx.xxx"
port	The tcp port of the remote device

Examples: BaosConOrientedTcpConnection.cpp, BaosSecureTcpConnection.cpp, ConnectionReconnect.cpp, DatapointValueIndication.cpp, GetDatapointDescription.cpp, GetDatapointDescriptionString.cpp, GetDatapointValue.cpp, GetParameterByte.cpp, GetServerItem.cpp, ServerItemIndication.cpp, SetDatapointValue.cpp, and SetServerItem.cpp.

◆ reopen()

void reopen ( )

overridevirtual

Reopens the underlying connection, has to be implemented by derived classes.

Implements BaosConnection.

Examples: ConnectionReconnect.cpp.

◆ isOpenImpl()

bool isOpenImpl ( )

overrideprotectedvirtual

The implementation function for getting the opened state of the connection.

Returns: Always false in the base class. Derived classes should overwrite this

Reimplemented from BaosConnection.

◆ closeImplAsync()

protocol::ResponseFuture closeImplAsync ( )

overrideprotectedvirtual

The implementation function for closing a connection.

Reimplemented from BaosConnection.

◆ startImpl()

void startImpl ( )

overrideprotectedvirtual

The implementation function for starting the connection class.

Reimplemented from BaosConnection.

◆ handleRxTcp()

void handleRxTcp ( IOEvent && event )

protected

Called for every Rx IOEvent (incoming, received)

Tries to parse the incoming packet

Parameters

event The RX IOEvent with the incming packet as payload

◆ handleTxTcp()

void handleTxTcp ( IOEvent && event )

protected

Called for every Tx IOEvent (outgoing, send, transmit)

Parameters

event The TX IOEvent with the packet to send as payload

◆ sendImpl()

protocol::ResponseFuture sendImpl ( BaosFrame && frame )

overrideprotectedvirtual

The implementation function for sending bytes to the connected device.

Implements BaosConnection.

◆ onStateChange()

void onStateChange	(	State	oldState,
		State	newState
	)

overrideprotectedvirtual

Invoked if the internal connection state should be changed.

Reimplemented from BaosConnection.

Member Data Documentation

◆ ensureAutoConnect_

bool ensureAutoConnect_ {true}

protected

Ensure auto connect in legacy mode (e.g. 774.1 with auto connect mode)

◆ verifyProtocolVersion_

bool verifyProtocolVersion_ {true}

protected

Verify on open the BAOS binary protocol version

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

BaosTcpConnection.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ enableEnsureAutoConnect()

◆ open()

◆ reopen()

◆ isOpenImpl()

◆ closeImplAsync()

◆ startImpl()

◆ handleRxTcp()

◆ handleTxTcp()

◆ sendImpl()

◆ onStateChange()

Member Data Documentation

◆ ensureAutoConnect_

◆ verifyProtocolVersion_