TCPSocket Class Reference

Class representing a TCP socket. More...

#include <tdme/os/network/TCPSocket.h>

Inheritance diagram for TCPSocket:

Collaboration diagram for TCPSocket:

Public Member Functions
virtual	~TCPSocket ()
	Public destructor. More...
size_t	read (void *buf, const size_t bytes)
	Reads up to "bytes" bytes from socket. More...
size_t	write (void *buf, const size_t bytes)
	Writes up to "bytes" bytes to socket. More...
void	connect (const string &ip, const unsigned int port)
	Connects a socket to given IP and port. More...
void	setTCPNoDelay ()
	Disables nagle's algorithm. More...
bool	accept (TCPSocket &_socket)
	Accepts a socket from a server socket. More...
Public Member Functions inherited from NetworkSocket
NetworkSocket &	operator= (NetworkSocket &socket)
	copy operator More...
	NetworkSocket ()
	Protected constructor. More...
virtual	~NetworkSocket ()
	public destructor More...
const string &	getAddress ()
	returns the end points ip address More...
const unsigned int	getPort ()
	returns the end points port More...
void	shutdown ()
	shuts socket down for reading and writing More...
void	bind (const string &ip, const unsigned int port)
	Binds a socket to local ip and port. More...
void	setNonBlocked ()
	sets the socket non blocked More...
void	close ()
	Closes the socket. More...

Static Public Member Functions
static void	create (TCPSocket &socket, IpVersion ipVersion)
	Creates a TCP socket. More...
static void	createServerSocket (TCPSocket &socket, const std::string &ip, const unsigned int port, const int backlog)
	Creates a TCP server socket. More...
Static Public Member Functions inherited from NetworkSocket
static IpVersion	determineIpVersion (const string &ip)
	Determine IP version. More...

Additional Inherited Members
Public Types inherited from NetworkSocket
enum	IpVersion { IPV4 , IPV6 }
Protected Attributes inherited from NetworkSocket
IpVersion	ipVersion
int	descriptor
string	ip
unsigned int	port

Detailed Description

Class representing a TCP socket.

Author

Andreas Drewke

Definition at line 15 of file TCPSocket.h.

Constructor & Destructor Documentation

~TCPSocket()

~TCPSocket ( )

virtual

Public destructor.

public destructor

Definition at line 43 of file TCPSocket.cpp.

Member Function Documentation

accept()

bool accept

(

TCPSocket &

_socket

)

Accepts a socket from a server socket.

Parameters

_socket

socket

Exceptions

tdme::os::network::NetworkSocketException

Returns

if socket was accepted

Definition at line 182 of file TCPSocket.cpp.

connect()

void connect	(	const string &	ip,
		const unsigned int	port
	)

Connects a socket to given IP and port.

Parameters

ip	ip
port	port

Exceptions

tdme::os::network::NetworkSocketException

Definition at line 99 of file TCPSocket.cpp.

create()

void create ( TCPSocket &  socket, IpVersion  ipVersion  )

static

Creates a TCP socket.

Parameters

socket	socket
ipVersion	IP version

Exceptions

tdme::os::network::NetworkSocketException

Definition at line 81 of file TCPSocket.cpp.

createServerSocket()

void createServerSocket ( TCPSocket &  socket, const std::string &  ip, const unsigned int  port, const int  backlog  )

static

Creates a TCP server socket.

Parameters

socket	socket
ip	ip
port	port
backlog	backlog

Exceptions

tdme::os::network::NetworkSocketException

Returns

socket

Definition at line 146 of file TCPSocket.cpp.

read()

size_t read	(	void *	buf,
		const size_t	bytes
	)

Reads up to "bytes" bytes from socket.

Parameters

buf	buffer to write to
bytes	bytes to receive

Exceptions

tdme::os::network::NetworkIOException

Returns

bytes read

Definition at line 46 of file TCPSocket.cpp.

setTCPNoDelay()

void setTCPNoDelay

(

)

Disables nagle's algorithm.

Exceptions

tdme::os::network::NetworkSocketException

Definition at line 169 of file TCPSocket.cpp.

write()

size_t write	(	void *	buf,
		const size_t	bytes
	)

Writes up to "bytes" bytes to socket.

Parameters

buf	buffer to read from
bytes	bytes to send

Exceptions

tdme::os::network::NetworkIOException

Returns

bytes written

Definition at line 60 of file TCPSocket.cpp.

---

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

• /home/andreas/Development/drewke.net/tdme2/src/tdme/os/network/TCPSocket.h
• /home/andreas/Development/drewke.net/tdme2/src/tdme/os/network/TCPSocket.cpp