Developer Documentation
RAVL, Recognition And Vision Library
USER HOME PAGE CLASS LIST CONTENTS
Ravl - OS - Network - NetEndPointC
 

  PUBLIC
NetEndPointC::NetEndPointC(void)
NetEndPointC::NetEndPointC(SocketC &,bool)
NetEndPointC::NetEndPointC(const StringC &,bool)
NetEndPointC::NetEndPointC(bool)
NetEndPointC::NetEndPointC(NetEndPointBodyC &)
NetEndPointC::Body(void)
NetEndPointC::Body(void) const
NetEndPointC::RunTransmit(void)
NetEndPointC::RunReceive(void)
NetEndPointC::RunDecode(void)
NetEndPointC::IsOpen(void) const
NetEndPointC::RemoteUser(void) const
NetEndPointC::Init(SocketC &)
NetEndPointC::Ready(void)
NetEndPointC::WaitSetupComplete(void)
NetEndPointC::Close(void)
NetEndPointC::Transmit(const NetPacketC &)
NetEndPointC::MsgInit(StringC &)
NetEndPointC::Register(const NetMsgRegisterC &)
NetEndPointC::Send(UIntT)
NetEndPointC::Send(UIntT,const Data1T &)
NetEndPointC::Send(UIntT,const Data1T &,const Data2T &)
NetEndPointC::Send(UIntT,const Data1T &,const Data2T &,const Data3T &)
NetEndPointC::RegisterR(UIntT,const StringC &,ObjT &,bool (*func)() )
NetEndPointC::RegisterR(UIntT,const StringC &,ObjT &,bool (*func)(DataT &) )
NetEndPointC::RegisterR(UIntT,const StringC &,ObjT &,bool (*func)(Data1T &,Data2T &) )
NetEndPointC::RegisterR(UIntT,const StringC &,ObjT &,bool (*func)(Data1T &,Data2T &,Data3T &) )
NetEndPointC::Register(UIntT,const StringC &,ObjT &,bool (*func)() )
NetEndPointC::Register(UIntT,const StringC &,ObjT &,bool (*func)(DataT &) )
NetEndPointC::Register(UIntT,const StringC &,ObjT &,bool (*func)(Data1T &,Data2T &) )
NetEndPointC::Register(UIntT,const StringC &,ObjT &,bool (*func)(Data1T &,Data2T &,Data3T &) )
RCHandleC::operator =(const RCHandleC &)
RCHandleC::DeepCopy(UIntT) const
RCHandleC::operator ==(const RCHandleC &) const
RCHandleC::operator !=(const RCHandleC &) const
RCHandleC::Hash(void) const
RCHandleC::IsValid(void) const
RCHandleC::Invalidate(void)
RCHandleC::IsHandleType(const DT &) const
RCHandleC::CheckHandleType(const DT &) const
RCHandleC::Body(void)
RCHandleC::Body(void) const
RCHandleC::References(void) const
RCHandleC::operator <<(ostream &,const RCHandleC &)
RCHandleC::operator >>(istream &,RCHandleC &)

   NetEndPointC   
 
An end point for a network packet base protocol.
 
include "Ravl/OS/NetEndPoint.hh"
Created:13/12/2000 
Source file:Ravl/OS/Network/NetEndPoint.hh
User Level:Normal
Library:RavlNet
Example:exEndPoint.cc
In Scope:RavlN

Parent Classes: Derived Classes: Methods:
NetEndPointC()
Default constructor.
Creates an invalid handle.

NetEndPointC(SocketC & skt,bool autoInit = true)
Constructor.
If auto init is set to false, you must call the Ready() function when your ready to start processing network messages. If autoinit is true messages will start being processed as soon as the connection is established.

NetEndPointC(const StringC & addr,bool autoInit = true)
Constructor.
This connects to the given address.

If auto init is set to false, you must call the Ready() function when your ready to start processing network messages. If autoinit is true messages will start being processed as soon as the connection is established.


NetEndPointC(bool)
Create an uninitalised end point.

NetEndPointC(NetEndPointBodyC & bod)
Body constructor.

NetEndPointBodyC & Body()
Access body.

const NetEndPointBodyC & Body() const
Access body.

bool RunTransmit()
Handle packet transmition.

bool RunReceive()
Handle packet reception.

bool RunDecode()
Decodes incoming packets.

bool IsOpen() const
Is Connections open ?

const StringC & RemoteUser() const
Access name of remote user.

bool Init(SocketC & skt)
Setup a connection.
This should only be used if net end point has been created by the default constructor.

bool Ready()
Call when your ready to recieved data from the network..

bool WaitSetupComplete()
Wait for setup to complete.

bool Close()
Close connection.

void Transmit(const NetPacketC & pkt)
Queue a packet for transmition.

bool MsgInit(StringC & user)
Init message.

bool Register(const NetMsgRegisterC & nmsg)
Register new message handler.

bool Send(UIntT id)
Send a 0 paramiter message.

bool Send(UIntT id,const Data1T & dat1)
Send a 1 paramiter message.

bool Send(UIntT id,const Data1T & dat1,const Data2T & dat2)
Send a 2 paramiter message.

bool Send(UIntT id,const Data1T & dat1,const Data2T & dat2,const Data3T & dat3)
Send a 3 paramiter message.

bool RegisterR(UIntT mid,const StringC & msgName,ObjT & obj,bool (*func)() )
Register new message handler.
NB. This does not make a handle to 'obj', it is the users responsibility to ensure it is not deleted.

bool RegisterR(UIntT mid,const StringC & msgName,ObjT & obj,bool (*func)(DataT &) )
Register new message handler.
NB. This does not make a handle to 'obj', it is the users responsibility to ensure it is not deleted.

bool RegisterR(UIntT mid,const StringC & msgName,ObjT & obj,bool (*func)(Data1T &,Data2T &) )
Register new message handler.
NB. This does not make a handle to 'obj', it is the users responsibility to ensure it is not deleted.

bool RegisterR(UIntT mid,const StringC & msgName,ObjT & obj,bool (*func)(Data1T &,Data2T &,Data3T &) )
Register new message handler.
NB. This does not make a handle to 'obj', it is the users responsibility to ensure it is not deleted.

bool Register(UIntT mid,const StringC & msgName,ObjT & obj,bool (*func)() )
Register new message handler.
Hold a handle to the object called.

bool Register(UIntT mid,const StringC & msgName,ObjT & obj,bool (*func)(DataT &) )
Register new message handler.
Hold a handle to the object called.

bool Register(UIntT mid,const StringC & msgName,ObjT & obj,bool (*func)(Data1T &,Data2T &) )
Register new message handler.
Hold a handle to the object called.

bool Register(UIntT mid,const StringC & msgName,ObjT & obj,bool (*func)(Data1T &,Data2T &,Data3T &) )
Register new message handler.
Hold a handle to the object called.

#include "Ravl/RefCounter.hh"
const RCHandleC<NetEndPointBodyC> & operator =(const RCHandleC<NetEndPointBodyC> & oth)
Assign handle.

RCHandleC<NetEndPointBodyC> DeepCopy(UIntT levels = ((UIntT))) const
Do a deep copy of the object.

bool operator ==(const RCHandleC<NetEndPointBodyC> & oth) const
Are handles to the same object ?

bool operator !=(const RCHandleC<NetEndPointBodyC> & oth) const
Are handles to different objects ?

UIntT Hash() const
Default hash function.
This hashes on the address of the body.

bool IsValid() const
Test if this is a valid handle.

void Invalidate()
Invalidate this handle.
Unattaches the body from the handle.

bool IsHandleType(const DT &) const
Is handle of given type ?

void CheckHandleType(const DT & dummy) const
Check handle type. Throw an expception if not.

NetEndPointBodyC & Body()
Access body of object.

const NetEndPointBodyC & Body() const
Constant access to body of object.

UIntT References() const
Find the number of references to the body of this object.

ostream & operator <<(ostream & strm,const RCHandleC<NetEndPointBodyC> & obj)

istream & operator >>(istream & strm,RCHandleC<NetEndPointBodyC> & obj)


Maintainer:Charles Galambos, Created: 13/12/2000, Documentation by CxxDoc: Tue Aug 13 09:59:30 2002