Developer Documentation
Centre for Vision, Speech & Signal Processing
USER IN NAMESPACE AMMA TREE ROOT AMMA SEARCH AMMA HOME
 

  PUBLIC
SocketC::SocketC(void)
SocketC::SocketC(StringC,BooleanT)
SocketC::SocketC(StringC,UIntT,BooleanT)
SocketC::SocketC(struct sockaddr *,int,BooleanT)
SocketC::Body(void)
SocketC::Body(void) const
SocketC::Fd(void) const
SocketC::IsOpen(void) const
SocketC::Listen(BooleanT)
SocketC::Close(void)
SocketC::SetDontClose(BooleanT)
SocketC::ConnectedHost(void)
SocketC::ConnectedPort(void)
RCHandleC::IsValid(void) const
RCHandleC::IsValidObject(void) const
RCHandleC::operator=(const RCHandleC &)
RCHandleC::operator==(const RCHandleC &) const
RCHandleC::operator!=(const RCHandleC &) const
RCHandleC::Hash(void) const
RCHandleC::IsConst(void) const
RCHandleC::IsNotConst(void) const
RCHandleC::SetConst(void) const
RCHandleC::Invalidate(void)
RCHandleC::Body(void)
RCHandleC::Body(void) const
SocketC
 
Socket connection handle.
 
include "amma/Socket.hh"
User Level:Default
Library:SysNetwork
Example:exSocket.cc
Section:Basic Types.Network
In Scope:std

Comments:
For dealing with stream sockets.

Parent Classes: Methods:
SocketC()
Default constructor.
creates an invalid handle.

SocketC(StringC name,BooleanT server = false)
Open socket.

SocketC(StringC name,UIntT portno,BooleanT server = false)
Open socket.

SocketC(struct sockaddr * addr,int nfd,BooleanT server = false)
Open socket.

SocketBodyC & Body()
Access body.

const SocketBodyC & Body() const
Access body.

int Fd() const
Access file descriptor.

BooleanT IsOpen() const
Test if socket is open.

SocketC Listen(BooleanT block = true)
Listen for a connection from a client.
Can only be used on server sockets. If block is true, the call will not return until there is a valid client.

void Close()
Close the socket.

void SetDontClose(BooleanT ndontClose)
Setup don't close flag.

StringC ConnectedHost()
Get host name

IntT ConnectedPort()
Get other port number.

#include "amma/RCHandle.hh"
BooleanT IsValid() const
Check its a valid handle.

BooleanT IsValidObject() const
Check its a valid handle, and that the object is pointed to is also valid.

RCHandleC<SocketBodyC> & operator=(const RCHandleC<SocketBodyC> & oth)
Assignment.

BooleanT operator==(const RCHandleC<SocketBodyC> & oth) const
Comparison operator.

BooleanT operator!=(const RCHandleC<SocketBodyC> & oth) const
Comparison operator.

UIntT Hash() const
Hash function.x

BooleanT IsConst() const
Is object constant ?

BooleanT IsNotConst() const
Is object not constant ?

void SetConst(void) const
Lock the object.
This is const as a convience though it actual modified the object, often object you wish to ensure are constant already have const set. protected:

void Invalidate()
Turn this into an invalid handle.

SocketBodyC & Body()
Direct access to body.

const SocketBodyC & Body() const
Constant access to body.


Programmer:Charles Galambos, Documentation by CxxDoc: Tue Mar 20 10:49:27 2001