SocketsC - Socket client.

Developer Documentation

Centre for Vision, Speech & Signal Processing

Comments:
Open a client socket.

Parent Classes:

RawFileC

INetProtocolC

Variables:

struct hostent * hp;
struct sockaddr_in sin;
IntT sock;

Methods:

SocketsC()
~SocketsC(): Close socket
SocketsC(char * host,MUIndexT snum): Construct socket connection to port snum on host machine
int GetHost(char * host): Connect to host
ostream & operator<<(ostream & s,const SocketsC & t)

#include "amma/RawFileC.hh"

const RawFileC & operator=(const RawFileC & Oth): Assignment.
IntT Write(const void * buff,IntT size): Write 'size' bytes from 'buff' to file handle. returns number of charactors written.
IntT Read(void * buff,IntT size): Read from file.
IntT LSeek(IntT off,IntT where): Seek to start of file.
IntT Getfd() const: Get file handle.
IntT Close(): Close file handle.
BooleanT IsNoClose() const: Is no close flag set ?
void SetNoClose(BooleanT Val): Set no close flag.

#include "amma/INetProtocolC.hh"

IntT SetPort(sockaddr_in & sin,MUIndexT num): Set port to socket number
IntT OpenSocket(IntT & sock): Open SOCK_STREAM socket to PF_INET
IntT BindSocket(sockaddr_in & sin,IntT sock): Bind to socket
IntT ConnectSocket(sockaddr_in & sin,IntT & sock): Connect to socket
IntT CloseSocket(IntT sock): Close socket
IntT Listen(IntT sock): Listen to socket on server
IntT AcceptSocket(sockaddr_in & from,IntT sock,IntT & nsock): Accept socket on server

#include "amma/RawIOBas.hh"

IntT Write(const void * buff,IntT size): Write 'size' bytes from 'buff' to file handle. returns number of charactors written.
IntT Read(void * buff,IntT size): Read from file.
IntT LSeek(IntT off,IntT where): Seek to start of file. Ret: -1 == Error. otherwise absolute location of error.
IntT Close(): Close file handle.
IntT ErrorNo() const: Get a UNIX style error number. Ret: 0 == No error. -1 == Not supported.

#include "amma/BRefCnt.hh"

void AddReference(): Another reference to the object has been created.
void RemoveReference(): One reference to the object was deleted.
Locking scheme -------------- The object is possible to lock (to make constant). The scheme assumes that the object is created, it can be locked, after that it can only be destroyed. The locked object cannot be unlocked. This locking scheme is very useful during debugging, using assert() function, when it is necassary to check that object is treated as constant and the constancy is not violated by any casting or passing through the copy constructor of shared objects.
void SetConst(void) const: This locks the object.
Often objects you wish to lock are already const.
void SetConst(void): This locks the object.
BooleanT IsConst(void) const: Returns TRUE if the object is locked, ie. it is assumed to be constant.
BooleanT IsNotConst(void) const: Returns TRUE if the object is unlocked.
ie. there is no special information if the object is constant or not. Counter state information -------------------------
BooleanT ToBeDeleted() const: Returns TRUE if there is only one reference to the object and the whole object or its reference counting part can be deleted.
BooleanT ToBeDeletedRemoveIgnoreNoRemove(): Decrement refrence by 1 return true if this leaves no refrences to the object.
BooleanT ToBeDeletedRemove(): Decrement refrence by 1 return true if this leaves no refrences to the object. This also checks the NoRemove flag.
BooleanT BodyMightBeDeleted() const: Returns TRUE if the reference counted part of the object can be deleted, ie. flag NOREMOVE is false .
BooleanT IsCountZero() const: Are there any refrences left ?
BooleanT BRCPtrCanDeleteObject() const: Used by BRRCPtrC to establish if an object has ZERO refrences and can be deleted.
IntT Count() const: Returns the current state of the counter, ie. how many references to this object exist.
const BodyRefCounterC & operator=(const BodyRefCounterC & b): It has not meaning to assign object 'b' to this object because it would destroy a history of the object which is counted. So this is a dummy function.
BooleanT IsValidObject() const: Test if object is valid.
When amma check is disabled this always returns true.
BooleanT UserBitTest(IntT x) const: Test user flag.
void UserBitSet(IntT x,BooleanT setit = TRUE): Test user flag.
void UserBitZero(IntT x): Set bit to zero.
void ReportBRCError(char * Msg): Report error, used in BRCPtrC.
UIntT Hash() const: Hash on address of object.
void SetUndeletable(): Make object undeletable.
Usefull to prevent recursive deleting in graph structures. Only hackers need this function.
void ReportInvalidObject(char * Msg = 0) const: Tell user about validation failure.

#include "amma/RefCBase.hh"

LabelT Label() const: Returns the label of this reference counter.
The member function is useful mainly to recognize objects during debugging. The value of the label is uniquely defined pointer.

Programmer:Rupert J Young, Documentation by CxxDoc: Tue Mar 20 10:49:27 2001

SocketsC

Socket client.

include	"amma/SocketsC.hh"
User Level:	Default
Library:	Msckt
Example:	SockClient.cc
Section:	Utilities.Drivers.Socket
In Scope:	std