industrial::simple_socket::SimpleSocket Class Reference

Defines socket functions required for a simple connection type. More...

#include <simple_socket.h>

Inheritance diagram for industrial::simple_socket::SimpleSocket:

[legend]

List of all members.

Public Member Functions
bool	isConnected ()
	return connection status
	SimpleSocket ()
	Constructor.
virtual	~SimpleSocket ()
	Destructor.
Protected Member Functions
int	getSockHandle () const
bool	isReadyReceive (int timeout)
	returns true if socket data is ready to receive
void	logSocketError (char *msg, int rc)
virtual int	rawReceiveBytes (char *buffer, industrial::shared_types::shared_int num_bytes)=0
virtual int	rawSendBytes (char *buffer, industrial::shared_types::shared_int num_bytes)=0
bool	receiveBytes (industrial::byte_array::ByteArray &buffer, industrial::shared_types::shared_int num_bytes)
bool	sendBytes (industrial::byte_array::ByteArray &buffer)
virtual void	setConnected (bool connected)
void	setSockHandle (int sock_handle_)
Protected Attributes
char	buffer_ [MAX_BUFFER_SIZE+1]
	internal data buffer for receiving
bool	connected_
	flag indicating socket connection status
int	sock_handle_
	socket handle for sending/receiving data
sockaddr_in	sockaddr_
	address/port of remote socket
Static Protected Attributes
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)
static const int	SOCKET_FAIL = -1
	socket fail return value

---

Detailed Description

Defines socket functions required for a simple connection type.

Definition at line 119 of file simple_socket.h.

---

Constructor & Destructor Documentation

industrial::simple_socket::SimpleSocket::SimpleSocket

(

)

[inline]

Constructor.

Definition at line 126 of file simple_socket.h.

virtual industrial::simple_socket::SimpleSocket::~SimpleSocket

(

)

[inline, virtual]

Destructor.

Definition at line 131 of file simple_socket.h.

---

Member Function Documentation

int industrial::simple_socket::SimpleSocket::getSockHandle

(

)

const [inline, protected]

Definition at line 170 of file simple_socket.h.

bool industrial::simple_socket::SimpleSocket::isConnected

(

)

[inline, virtual]

return connection status

Returns:

true if connected

Implements industrial::smpl_msg_connection::SmplMsgConnection.

Definition at line 133 of file simple_socket.h.

bool industrial::simple_socket::SimpleSocket::isReadyReceive

(

int

timeout

)

[protected]

returns true if socket data is ready to receive

Parameters:

timeout

(ms) negative or zero values result in blocking

Returns:

true if data is ready to recieve

Definition at line 154 of file simple_socket.cpp.

void industrial::simple_socket::SimpleSocket::logSocketError	(	char *	msg,
		int	rc
	)			[inline, protected]

Definition at line 185 of file simple_socket.h.

virtual int industrial::simple_socket::SimpleSocket::rawReceiveBytes	(	char *	buffer,
		industrial::shared_types::shared_int	num_bytes
	)			[protected, pure virtual]

Implemented in industrial::tcp_socket::TcpSocket, and industrial::udp_socket::UdpSocket.

virtual int industrial::simple_socket::SimpleSocket::rawSendBytes	(	char *	buffer,
		industrial::shared_types::shared_int	num_bytes
	)			[protected, pure virtual]

Implemented in industrial::tcp_socket::TcpSocket, and industrial::udp_socket::UdpSocket.

bool industrial::simple_socket::SimpleSocket::receiveBytes	(	industrial::byte_array::ByteArray &	buffer,
		industrial::shared_types::shared_int	num_bytes
	)			[protected, virtual]

Implements industrial::smpl_msg_connection::SmplMsgConnection.

bool industrial::simple_socket::SimpleSocket::sendBytes

(

industrial::byte_array::ByteArray &

buffer

)

[protected, virtual]

Implements industrial::smpl_msg_connection::SmplMsgConnection.

Definition at line 52 of file simple_socket.cpp.

virtual void industrial::simple_socket::SimpleSocket::setConnected

(

bool

connected

)

[inline, protected, virtual]

Definition at line 180 of file simple_socket.h.

void industrial::simple_socket::SimpleSocket::setSockHandle

(

int

sock_handle_

)

[inline, protected]

Definition at line 175 of file simple_socket.h.

---

Member Data Documentation

char industrial::simple_socket::SimpleSocket::buffer_[MAX_BUFFER_SIZE+1] [protected]

internal data buffer for receiving

Definition at line 168 of file simple_socket.h.

bool industrial::simple_socket::SimpleSocket::connected_ [protected]

flag indicating socket connection status

Definition at line 153 of file simple_socket.h.

const int industrial::simple_socket::SimpleSocket::MAX_BUFFER_SIZE = 1024 [static, protected]

maximum size of buffer for receiving data (fixed memory size used in order to avoid dynamic memory allocation)

Definition at line 164 of file simple_socket.h.

int industrial::simple_socket::SimpleSocket::sock_handle_ [protected]

socket handle for sending/receiving data

Definition at line 143 of file simple_socket.h.

sockaddr_in industrial::simple_socket::SimpleSocket::sockaddr_ [protected]

address/port of remote socket

Definition at line 148 of file simple_socket.h.

const int industrial::simple_socket::SimpleSocket::SOCKET_FAIL = -1 [static, protected]

socket fail return value

Definition at line 158 of file simple_socket.h.

---

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

• simple_socket.h
• simple_socket.cpp