Main Page   Packages   Class Hierarchy   Alphabetical List   Data Structures   File List   Namespace Members   Data Fields   Globals  

clawsoft.SocketBase Class Reference

#include <SocketBase.h>

Inheritance diagram for clawsoft.SocketBase:

Inheritance graph
[legend]
Collaboration diagram for clawsoft.SocketBase:

Collaboration graph
[legend]

Detailed Description

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

Definition at line 17 of file SocketBase.h.

Public Methods

 SocketBase ()
 ~SocketBase ()
const int getSocket ()
 Returns the socket's file descriptor value.

int setSoTimeout (int)
 Defines the timeout before closing connection to the other end of communication.

char * getClassName ()
 Returns the name of the current class.


Protected Methods

int setSockOption (int opname, void *optval, unsigned int siz)
 Is an interface to setsockopt.

int setTCPOption (int opname, void *optval, unsigned int siz)
void setClassName (char *n)
 Call this method when you need to set the name of the class you're creating, typically int it's constructor, remeber that you must set the classname for every clas you create, that way you can have more information while being in a debuging process.


Protected Attributes

int sock
 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.

Constructor & Destructor Documentation

clawsoft.SocketBase::SocketBase (    ) 
 

Definition at line 11 of file SocketBase.cpp.

clawsoft.SocketBase.~SocketBase (    )  [inline]
 

Definition at line 35 of file SocketBase.h.

Member Function Documentation

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

Returns the name of the current class.

Definition at line 18 of file Object.cpp.

References clawsoft.Object.__cls_name.

const int clawsoft.SocketBase.getSocket (    )  [inline]
 

Returns the socket's file descriptor value.

Definition at line 38 of file SocketBase.h.

References clawsoft.SocketBase.sock.

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

Call this method when you need to set the name of the class you're creating, typically int it's constructor, remeber that you must set the classname for every clas you create, that way you can have more information while being in a debuging process.

Definition at line 14 of file Object.cpp.

References clawsoft.Object.__cls_name.

Referenced by clawsoft.ArrayOutOfBoundsException.ArrayOutOfBoundsException(), clawsoft.BrokenPipeException.BrokenPipeException(), clawsoft.Dialog.CancelButton.CancelButton(), clawsoft.CantLoadDSOException.CantLoadDSOException(), clawsoft.CantUnloadDSOException.CantUnloadDSOException(), clawsoft.ConnectionRefusedException.ConnectionRefusedException(), clawsoft.ConnectionTimeoutException.ConnectionTimeoutException(), clawsoft.Dialog.Dialog(), clawsoft.DSOException.DSOException(), clawsoft.DSOSymbolException.DSOSymbolException(), clawsoft.ElementNotFoundException.ElementNotFoundException(), clawsoft.Font.Font(), clawsoft.GameSelector.GameSelector(), clawsoft.Dialog.HelpButton.HelpButton(), clawsoft.IOException.IOException(), clawsoft.KeyboardEvent.KeyboardEvent(), clawsoft.LoginDialog.LoginDialog(), clawsoft.Mutex.Mutex(), clawsoft.MutexException.MutexException(), clawsoft.NetworkException.NetworkException(), clawsoft.NetworkUnreachableException.NetworkUnreachableException(), clawsoft.NoMoreTokensException.NoMoreTokensException(), clawsoft.NullPointerException.NullPointerException(), clawsoft.NumberException.NumberException(), clawsoft.Object.Object(), clawsoft.Dialog.OKButton.OKButton(), clawsoft.Plugin.Plugin(), clawsoft.ProcOutOfFileDescriptorsException.ProcOutOfFileDescriptorsException(), Random.Random(), clawsoft.ServerSocket.ServerSocket(), clawsoft.Socket.Socket(), clawsoft.SocketAlreadyBoundedException.SocketAlreadyBoundedException(), clawsoft.SocketAlreadyUsedException.SocketAlreadyUsedException(), clawsoft.SocketUnableToReadException.SocketUnableToReadException(), clawsoft.SocketUnableToWriteException.SocketUnableToWriteException(), clawsoft.SysOutOfFileDescriptorsException.SysOutOfFileDescriptorsException(), clawsoft.TextBox.TextBox(), clawsoft.TextButton.TextButton(), clawsoft.TextField.TextField(), clawsoft.Thread.Thread(), clawsoft.UnableToLockMutexException.UnableToLockMutexException(), clawsoft.UnableToUnlockMutexException.UnableToUnlockMutexException(), and clawsoft.Window.Window().

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

Is an interface to setsockopt.

Definition at line 13 of file SocketBase.cpp.

References clawsoft.SocketBase.sock.

Referenced by clawsoft.SocketBase.setSoTimeout().

int clawsoft.SocketBase::setSoTimeout (  int    ) 
 

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

Definition at line 28 of file SocketBase.cpp.

References clawsoft.SocketBase.setSockOption().

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

Definition at line 23 of file SocketBase.cpp.

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.

Definition at line 27 of file SocketBase.h.

Referenced by clawsoft.ServerSocket.accept(), clawsoft.Socket.CreateSocket(), clawsoft.ServerSocket.CreateSocket(), clawsoft.Socket.getPort(), clawsoft.ServerSocket.getPort(), clawsoft.Socket.operator=(), and clawsoft.Socket.Socket().

int clawsoft.SocketBase.sock [protected]
 

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

Definition at line 22 of file SocketBase.h.

Referenced by clawsoft.ServerSocket.accept(), clawsoft.Socket.close(), clawsoft.ServerSocket.close(), clawsoft.Socket.CreateSocket(), clawsoft.ServerSocket.CreateSocket(), clawsoft.SocketBase.getSocket(), clawsoft.Socket.operator=(), clawsoft.Socket.operator>>(), clawsoft.Socket.read(), clawsoft.SocketBase.setSockOption(), clawsoft.Socket.Socket(), and clawsoft.Socket.write().

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

Powered by:

SourceForge Logo