---

clawsoft::SocketBase Class Reference

#include <SocketBase.h>

Inheritance diagram for clawsoft::SocketBase:

[legend]Collaboration diagram for clawsoft::SocketBase:

[legend]

---

Detailed Description

This is the socket parent class, this one contains information and methods shared by client and server sockets.

Public Methods
const TCPsocket	getSocket ()
	Returns the socket's file descriptor value.
int	setSoTimeout (int)
	Defines the timeout before closing connection to the other end of communication.
const char *	getClassName ()
	Returns the name of the current class.
Static Public Methods
int	installedCPUs ()
	This will return how many CPUs are installed in the system.
double	cpuSpeed ()
	This will return the CPU speed in megahertz.
int	totalMemory ()
	Will return the total amount of system memory.
int	freeMemory ()
	Will return the total amount of free system memory.
void	usleep (Uint32 usec)
	Will freeze the software for usec microseconds.
Protected Methods
int	setSockOption (int opname, void *optval, unsigned int siz)
	Is an interface to setsockopt.
void	setClassName (const char *n)
	Call this method when you need to set the name of the class you're creating, typically in it's constructor, remember that you must set the classname for every class you create, that way you can have more information while debugging.
Protected Attributes
TCPsocket	tcpsock
	This file descriptor represents the socket itself as returned by socket(2) and accept(2).
int	port
	Defines the communications port used by the socket or the port which the socket server uses to listen requests.

---

Member Function Documentation

double clawsoft::System::cpuSpeed (    )  [static, inherited]

This will return the CPU speed in megahertz.

int clawsoft::System::freeMemory (    )  [static, inherited]

Will return the total amount of free system memory.

const char * clawsoft::Object::getClassName (    )  [inherited]

Returns the name of the current class.

const TCPsocket clawsoft::SocketBase::getSocket (    )  [inline]

Returns the socket's file descriptor value.

int clawsoft::System::installedCPUs (    )  [static, inherited]

This will return how many CPUs are installed in the system.

void clawsoft::Object::setClassName (  const char *    n )  [protected, inherited]

Call this method when you need to set the name of the class you're creating, typically in it's constructor, remember that you must set the classname for every class you create, that way you can have more information while debugging.

int clawsoft::SocketBase::setSockOption (  int    opname, void *    optval, unsigned int    siz )  [protected]

Is an interface to setsockopt.

int clawsoft::SocketBase::setSoTimeout (  int    )

Defines the timeout before closing connection to the other end of communication.

int clawsoft::System::totalMemory (    )  [static, inherited]

Will return the total amount of system memory.

void clawsoft::System::usleep (  Uint32    usec )  [static, inherited]

Will freeze the software for usec microseconds.

---

Field Documentation

int clawsoft::SocketBase::port [protected]

Defines the communications port used by the socket or the port which the socket server uses to listen requests.

TCPsocket clawsoft::SocketBase::tcpsock [protected]

This file descriptor represents the socket itself as returned by socket(2) and accept(2).

---

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

• SocketBase.h
• SocketBase.cpp

Authors:

Juan V. Guerrero
Jannette C. Mejia
Juan C. Guevara

Powered by: