Public Member Functions | Private Member Functions
industrial::smpl_msg_connection::SmplMsgConnection Class Reference

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:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual bool isConnected ()=0
 return connection status
virtual bool makeConnect ()=0
 connects to the remote host
virtual bool receiveMsg (industrial::simple_message::SimpleMessage &message)
 Receives a message using the data connection.
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.
virtual bool sendMsg (industrial::simple_message::SimpleMessage &message)
 Sends a message using the data connection.

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.
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.

Detailed Description

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

1. The connection is capable of sending raw bytes (encapsulated within a simple message)

2. 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 67 of file smpl_msg_connection.h.


Member Function Documentation

return connection status

Returns:
true if connected

Implemented in industrial::simple_socket::SimpleSocket.

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 
) [private, pure virtual]

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

Parameters:
datato receive.
size(in bytes) of data to receive
Returns:
true if successful

Implemented in industrial::simple_socket::SimpleSocket.

Receives a message using the data connection.

Parameters:
populatedwith received message
Returns:
true if successful

Reimplemented in industrial::udp_socket::UdpSocket.

Definition at line 79 of file smpl_msg_connection.cpp.

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

Parameters:
messageto send
populatedwith received message
verbositylevel of low level logging
Returns:
true if successful

Definition at line 127 of file smpl_msg_connection.cpp.

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

Parameters:
datato send.
Returns:
true if successful

Implemented in industrial::simple_socket::SimpleSocket.

Sends a message using the data connection.

Parameters:
messageto 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:


simple_message
Author(s): Shaun Edwards
autogenerated on Mon Oct 6 2014 00:54:18