sick_scan_xd::ServerSocket Class Reference

#include <server_socket.h>

Public Member Functions
virtual void	close (void)
virtual bool	connect ()
virtual socket_t &	connectedSocket (void)
virtual bool	is_open (void)
virtual bool	open (int tcp_port, bool bTcpAnyHost=false)
virtual int	read (int num_bytes, std::vector< uint8_t > &out_buffer, bool read_blocking=true)
virtual bool	read (int num_bytes, uint8_t *out_buffer, bool read_blocking=true)
	ServerSocket ()
virtual bool	write (const uint8_t *buffer, int num_bytes, int num_retries_on_error=1)
virtual	~ServerSocket ()

Protected Attributes
int	m_iListenPortNumber
socket_t	m_tConnectedSocket
socket_t	m_tListenSocket

Detailed Description

Class sick_scan_xd::ServerSocket implements a server socket connection.

Definition at line 83 of file server_socket.h.

Constructor & Destructor Documentation

ServerSocket()

sick_scan_xd::ServerSocket::ServerSocket

(

)

Constructor.

Definition at line 92 of file server_socket.cpp.

~ServerSocket()

sick_scan_xd::ServerSocket::~ServerSocket ( )

virtual

Destructor, closes the tcp connections.

Definition at line 99 of file server_socket.cpp.

Member Function Documentation

close()

void sick_scan_xd::ServerSocket::close ( void  )

virtual

Closes the tcp connections.

Definition at line 325 of file server_socket.cpp.

connect()

bool sick_scan_xd::ServerSocket::connect ( )

virtual

Waits for a client to connect, creates a socket to read and write.

Returns

true on success, false on failure

Definition at line 159 of file server_socket.cpp.

connectedSocket()

virtual socket_t& sick_scan_xd::ServerSocket::connectedSocket ( void  )

inlinevirtual

Definition at line 138 of file server_socket.h.

is_open()

bool sick_scan_xd::ServerSocket::is_open ( void  )

virtual

Returns

returns true, if the server socket is connected to a client, otherwise false

Definition at line 344 of file server_socket.cpp.

open()

bool sick_scan_xd::ServerSocket::open ( int  tcp_port, bool  bTcpAnyHost = false  )

virtual

Opens a listening server socket.

Returns

true on success, false on failure

Definition at line 107 of file server_socket.cpp.

read() [1/2]

int sick_scan_xd::ServerSocket::read ( int  num_bytes, std::vector< uint8_t > &  out_buffer, bool  read_blocking = true  )

virtual

Reads bytes from the socket.

Returns

number of bytes read, or -1 on error (invalid socket, broken connection)

Definition at line 197 of file server_socket.cpp.

read() [2/2]

bool sick_scan_xd::ServerSocket::read ( int  num_bytes, uint8_t *  out_buffer, bool  read_blocking = true  )

virtual

Read <num_bytes> bytes from the socket.

Returns

true on success, false on failure

Definition at line 264 of file server_socket.cpp.

write()

bool sick_scan_xd::ServerSocket::write ( const uint8_t *  buffer, int  num_bytes, int  num_retries_on_error = 1  )

virtual

Writes bytes to the socket.

Returns

true on success, false on failure

Definition at line 277 of file server_socket.cpp.

Member Data Documentation

m_iListenPortNumber

int sick_scan_xd::ServerSocket::m_iListenPortNumber

protected

Definition at line 142 of file server_socket.h.

m_tConnectedSocket

socket_t sick_scan_xd::ServerSocket::m_tConnectedSocket

protected

Definition at line 144 of file server_socket.h.

m_tListenSocket

socket_t sick_scan_xd::ServerSocket::m_tListenSocket

protected

Definition at line 143 of file server_socket.h.

---

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

• server_socket.h
• server_socket.cpp