User Documentation
RAVL, Recognition And Vision Library
DEVELOP HOME PAGE CLASS LIST CONTENTS
Ravl - OS - Network - NetEndPointBodyC
 

  PUBLIC
NetEndPointBodyC::NetEndPointBodyC(SocketC &,bool)
NetEndPointBodyC::NetEndPointBodyC(const StringC &,bool)
NetEndPointBodyC::NetEndPointBodyC(void)
NetEndPointBodyC::~NetEndPointBodyC(void)
NetEndPointBodyC::IsOpen(void) const
NetEndPointBodyC::Init(SocketC &)
NetEndPointBodyC::WaitSetupComplete(void)
NetEndPointBodyC::Close(void)
NetEndPointBodyC::RemoteUser(void) const
NetEndPointBodyC::Transmit(const NetPacketC &)
NetEndPointBodyC::MsgInit(StringC &)
NetEndPointBodyC::Ready(void)
NetEndPointBodyC::SndInit(StringC &)
NetEndPointBodyC::Send(UIntT)
NetEndPointBodyC::Send(UIntT,const Data1T &)
NetEndPointBodyC::Send(UIntT,const Data1T &,const Data2T &)
NetEndPointBodyC::Send(UIntT,const Data1T &,const Data2T &,const Data3T &)
NetEndPointBodyC::Register(const NetMsgRegisterC &)
NetEndPointBodyC::Find(UIntT) const
NetEndPointBodyC::RegisterR(UIntT,const StringC &,ObjT &,bool (*func)() )
NetEndPointBodyC::RegisterR(UIntT,const StringC &,ObjT &,bool (*func)(DataT &) )
NetEndPointBodyC::RegisterR(UIntT,const StringC &,ObjT &,bool (*func)(Data1T &,Data2T &) )
NetEndPointBodyC::RegisterR(UIntT,const StringC &,ObjT &,bool (*func)(Data1T &,Data2T &,Data3T &) )
NetEndPointBodyC::Register(UIntT,const StringC &,ObjT &,bool (*func)() )
NetEndPointBodyC::Register(UIntT,const StringC &,ObjT &,bool (*func)(DataT &) )
NetEndPointBodyC::Register(UIntT,const StringC &,ObjT &,bool (*func)(Data1T &,Data2T &) )
NetEndPointBodyC::Register(UIntT,const StringC &,ObjT &,bool (*func)(Data1T &,Data2T &,Data3T &) )
RCBodyVC::Save(ostream &) const
RCBodyVC::Save(BinOStreamC &) const
RCBodyVC::Copy(void) const
RCBodyVC::DeepCopy(UIntT) const
RCBodyC::References(void) const
RCBodyC::Copy(void) const
RCBodyC::DeepCopy(UIntT) const
RCBodyC::IncRefCounter(void)
RCBodyC::DecRefCounter(void)

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

Parent Classes: Derived Classes: Variables:
Methods:
NetEndPointBodyC(SocketC & skt,bool nautoInit = 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.

NetEndPointBodyC(const StringC & skt,bool nautoInit = 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.

NetEndPointBodyC()
Default constructor.

~NetEndPointBodyC()
Destructor.

bool IsOpen() const
Is Connections open ?

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

bool WaitSetupComplete()
Wait for setup to complete.

bool Close()
Close connection.

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

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

bool MsgInit(StringC & user)
Init message.

bool Ready()
Initalise link.

void SndInit(StringC & user)
Send init message.

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 Register(const NetMsgRegisterC & nmsg)
Register new message handler.

NetMsgRegisterC Find(UIntT id) const
Search for message decode/encode of type 'id'.

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.
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)(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 Register(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 Register(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.

#include "Ravl/RCHandleV.hh"
bool Save(ostream & out) const
Save to stream 'out'.

bool Save(BinOStreamC & out) const
Save to binary stream 'out'.

RCBodyVC & Copy() const
Make copy of body.
This should be provided in derived classes. this funtion will issue an assertion failure if called.

RCBodyC & DeepCopy(UIntT levels = ((UIntT))) const
Make a deep copy of body.
This should be provided in derived classes. this funtion will issue an assertion failure if called.

#include "Ravl/RefCounter.hh"
UIntT References() const
Access count of handles open to this object.

RCBodyC & Copy() const
Make copy of body.
This should be provided in derived classes. this funtion will issue an assertion failure if called.

RCBodyC & DeepCopy(UIntT levels = ((UIntT))) const
Make a deep copy of body.
This should be provided in derived classes. this funtion will issue an assertion failure if called.

void IncRefCounter()
Increment reference counter.

bool DecRefCounter()
Decrement reference counter.


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