NetworkSocket Class Reference

Base class of network sockets. More...

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

Inheritance diagram for NetworkSocket:

Collaboration diagram for NetworkSocket:

Public Types
enum	IpVersion { IPV4 , IPV6 }

Public Member Functions
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 IpVersion	determineIpVersion (const string &ip)
	Determine IP version. More...

Protected Attributes
IpVersion	ipVersion
int	descriptor
string	ip
unsigned int	port

Friends
class	KernelEventMechanism

Detailed Description

Base class of network sockets.

Author

Andreas Drewke

Definition at line 17 of file NetworkSocket.h.

Member Enumeration Documentation

IpVersion

enum IpVersion

Enumerator
IPV4
IPV6

Definition at line 21 of file NetworkSocket.h.

Constructor & Destructor Documentation

NetworkSocket()

NetworkSocket

(

)

Protected constructor.

Definition at line 33 of file NetworkSocket.cpp.

~NetworkSocket()

~NetworkSocket ( )

virtual

public destructor

Definition at line 36 of file NetworkSocket.cpp.

Member Function Documentation

bind()

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

Binds a socket to local ip and port.

Parameters

ip	ip
port	port

Exceptions

tdme::os::network::NetworkSocketException

Definition at line 51 of file NetworkSocket.cpp.

close()

void close

(

)

Closes the socket.

Definition at line 125 of file NetworkSocket.cpp.

determineIpVersion()

NetworkSocket::IpVersion determineIpVersion ( const string &  ip )

static

Determine IP version.

Parameters

ip

ip

Returns

ip version

Definition at line 134 of file NetworkSocket.cpp.

getAddress()

const std::string & getAddress

(

)

returns the end points ip address

Returns

end point ip address

Definition at line 39 of file NetworkSocket.cpp.

getPort()

const unsigned int getPort

(

)

returns the end points port

Returns

end point port

Definition at line 43 of file NetworkSocket.cpp.

operator=()

NetworkSocket & operator=

(

NetworkSocket &

socket

)

copy operator

Definition at line 26 of file NetworkSocket.cpp.

setNonBlocked()

void setNonBlocked

(

)

sets the socket non blocked

Exceptions

tdme::os::network::NetworkSocketException

Definition at line 99 of file NetworkSocket.cpp.

shutdown()

void shutdown

(

)

shuts socket down for reading and writing

Definition at line 47 of file NetworkSocket.cpp.

Friends And Related Function Documentation

KernelEventMechanism

friend class KernelEventMechanism

friend

Definition at line 18 of file NetworkSocket.h.

Member Data Documentation

descriptor

int descriptor

protected

Definition at line 83 of file NetworkSocket.h.

ip

string ip

protected

Definition at line 84 of file NetworkSocket.h.

ipVersion

IpVersion ipVersion

protected

Definition at line 82 of file NetworkSocket.h.

port

unsigned int port

protected

Definition at line 85 of file NetworkSocket.h.

---

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

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