Defines an interface and common methods for sending simple messages (see simple_message). This interface makes a bare minimum of assumptions: More...

#include <smpl_msg_connection.h>

Inheritance diagram for industrial::smpl_msg_connection::SmplMsgConnection:

[legend]

Public Member Functions
virtual bool	isConnected ()=0
	return connection status More...

virtual bool	makeConnect ()=0
	connects to the remote host More...

virtual bool	receiveMsg (industrial::simple_message::SimpleMessage &message)
	Receives a message using the data connection. More...

bool	sendAndReceiveMsg (industrial::simple_message::SimpleMessage &send, industrial::simple_message::SimpleMessage &recv, bool verbose=false)
	Performs a complete send and receive. This is helpful when sending a message that requires and explicit reply. More...

virtual bool	sendMsg (industrial::simple_message::SimpleMessage &message)
	Sends a message using the data connection. More...

Private Member Functions
virtual bool	receiveBytes (industrial::byte_array::ByteArray &buffer, industrial::shared_types::shared_int num_bytes)=0
	Method used by receive message interface method. This should be overridden for the specific connection type. More...

virtual bool	sendBytes (industrial::byte_array::ByteArray &buffer)=0
	Method used by send message interface method. This should be overridden for the specific connection type. More...

Detailed Description

Defines an interface and common methods for sending simple messages (see simple_message). This interface makes a bare minimum of assumptions:

The connection is capable of sending raw bytes (encapsulated within a simple message)
The data connection has an explicit connect that establishes the connection (and an associated disconnect method). NOTE: For data connections that are connectionless, such as UDP, the connection method can be a NULL operation.

Definition at line 61 of file smpl_msg_connection.h.

Member Function Documentation

virtual bool industrial::smpl_msg_connection::SmplMsgConnection::isConnected ( )

pure virtual

return connection status

Returns: true if connected

Implemented in industrial::simple_socket::SimpleSocket.

virtual bool industrial::smpl_msg_connection::SmplMsgConnection::makeConnect ( )

pure virtual

connects to the remote host

Returns: true on success, false otherwise

Implemented in industrial::tcp_client::TcpClient, industrial::tcp_server::TcpServer, industrial::udp_client::UdpClient, and industrial::udp_server::UdpServer.

virtual bool industrial::smpl_msg_connection::SmplMsgConnection::receiveBytes	(	industrial::byte_array::ByteArray &	buffer,
		industrial::shared_types::shared_int	num_bytes
	)

privatepure virtual

Method used by receive message interface method. This should be overridden for the specific connection type.

Parameters

data	to receive.
size	(in bytes) of data to receive

Returns: true if successful

Implemented in TestServer, and industrial::simple_socket::SimpleSocket.

bool industrial::smpl_msg_connection::SmplMsgConnection::receiveMsg ( industrial::simple_message::SimpleMessage & message )

virtual

Receives a message using the data connection.

Parameters

populated with received message

Returns: true if successful

Definition at line 79 of file smpl_msg_connection.cpp.

bool industrial::smpl_msg_connection::SmplMsgConnection::sendAndReceiveMsg	(	industrial::simple_message::SimpleMessage &	send,
		industrial::simple_message::SimpleMessage &	recv,
		bool	verbose = `false`
	)

Performs a complete send and receive. This is helpful when sending a message that requires and explicit reply.

Parameters

message	to send
populated	with received message
verbosity	level of low level logging

Returns: true if successful

Definition at line 127 of file smpl_msg_connection.cpp.

virtual bool industrial::smpl_msg_connection::SmplMsgConnection::sendBytes ( industrial::byte_array::ByteArray & buffer )

privatepure virtual

Method used by send message interface method. This should be overridden for the specific connection type.

Parameters

data to send.

Returns: true if successful

Implemented in industrial::simple_socket::SimpleSocket, and TestClient.

bool industrial::smpl_msg_connection::SmplMsgConnection::sendMsg ( industrial::simple_message::SimpleMessage & message )

virtual

Sends a message using the data connection.

Parameters

message to send

Returns: true if successful

Definition at line 56 of file smpl_msg_connection.cpp.

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

Public Member Functions

Private Member Functions

Detailed Description

Member Function Documentation