#include <tcp_socket.h>

Inheritance diagram for industrial::tcp_socket::TcpSocket:

[legend]

Public Member Functions
	TcpSocket ()

virtual	~TcpSocket ()

Public Member Functions inherited from industrial::simple_socket::SimpleSocket
bool	isConnected ()
	return connection status More...

bool	isReadyReceive (int timeout)
	returns true if socket data is ready to receive More...

virtual void	setDisconnected ()

	SimpleSocket ()
	Constructor. More...

virtual	~SimpleSocket ()
	Destructor. More...

Public Member Functions inherited from industrial::smpl_msg_connection::SmplMsgConnection
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...

virtual bool	receiveMsg (industrial::simple_message::SimpleMessage &message, industrial::shared_types::shared_int timeout_ms)
	Receives a message using the data connection with a timeout. 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...

bool	sendAndReceiveMsg (industrial::simple_message::SimpleMessage &send, industrial::simple_message::SimpleMessage &recv, industrial::shared_types::shared_int timeout_ms, bool verbose=false)
	Performs a complete send and receive with a timeout. 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
bool	rawPoll (int timeout, bool &ready, bool &error)
	polls socket for data or error More...

int	rawReceiveBytes (char *buffer, industrial::shared_types::shared_int num_bytes)

int	rawSendBytes (char *buffer, industrial::shared_types::shared_int num_bytes)

Additional Inherited Members
Protected Member Functions inherited from industrial::simple_socket::SimpleSocket
	__attribute__ ((deprecated("Please use: logSocketError(const char* msg, const int rc, const int error_no)"))) void logSocketError(const char *msg
	Logs message to error log and reports associated socket system error. More...

int	getSockHandle () const

void	logSocketError (const char *msg, const int rc, const int error_no)
	Logs message to error log and reports associated socket system error. More...

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

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

virtual void	setConnected (bool connected)

void	setSockHandle (int sock_handle_)

Protected Attributes inherited from industrial::simple_socket::SimpleSocket
char	buffer_ [MAX_BUFFER_SIZE+1]
	internal data buffer for receiving More...

bool	connected_
	flag indicating socket connection status More...

int	rc

int	sock_handle_
	socket handle for sending/receiving data More...

sockaddr_in	sockaddr_
	address/port of remote socket More...

Static Protected Attributes inherited from industrial::simple_socket::SimpleSocket
static const int	MAX_BUFFER_SIZE = 1024
	maximum size of buffer for receiving data (fixed memory size used in order to avoid dynamic memory allocation) More...

static const int	SOCKET_FAIL = -1
	socket fail return value More...

static const int	SOCKET_POLL_TO = 10
	socket ready polling timeout (ms) More...

Detailed Description

Definition at line 66 of file tcp_socket.h.

Constructor & Destructor Documentation

◆ TcpSocket()

industrial::tcp_socket::TcpSocket::TcpSocket ( )

Definition at line 54 of file tcp_socket.cpp.

◆ ~TcpSocket()

industrial::tcp_socket::TcpSocket::~TcpSocket ( )

virtual

Definition at line 58 of file tcp_socket.cpp.

Member Function Documentation

◆ rawPoll()

bool industrial::tcp_socket::TcpSocket::rawPoll	(	int	timeout,
		bool &	ready,
		bool &	error
	)

privatevirtual

polls socket for data or error

Parameters

timeout	(ms) negative or zero values result in blocking
ready	true if ready
except	true if exception

Returns: true if function DID NOT timeout (must check flags)

Implements industrial::simple_socket::SimpleSocket.

Definition at line 83 of file tcp_socket.cpp.

◆ rawReceiveBytes()

int industrial::tcp_socket::TcpSocket::rawReceiveBytes	(	char *	buffer,
		industrial::shared_types::shared_int	num_bytes
	)

privatevirtual

Implements industrial::simple_socket::SimpleSocket.

Definition at line 74 of file tcp_socket.cpp.

◆ rawSendBytes()

int industrial::tcp_socket::TcpSocket::rawSendBytes	(	char *	buffer,
		industrial::shared_types::shared_int	num_bytes
	)

privatevirtual

Implements industrial::simple_socket::SimpleSocket.

Definition at line 65 of file tcp_socket.cpp.

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

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TcpSocket()

◆ ~TcpSocket()

Member Function Documentation

◆ rawPoll()

◆ rawReceiveBytes()

◆ rawSendBytes()