class TMrbC2Lynx: public TNamed

__________________________________________________[C++ CLASS IMPLEMENTATION]

 Name:           c2lynx/src/TMrbC2Lynx.cxx
 Purpose:        MARaBOU client to connect to LynxOs/VME
 Description:    Implements class methods for a client to LynxOs/VME
 Keywords:
 Author:         R. Lutter
 Mailto:         <a href=mailto:rudi.lutter@physik.uni-muenchen.de>R. Lutter</a>
 Revision:       $Id: TMrbC2Lynx.cxx,v 1.17 2011-05-20 12:21:10 Marabou Exp $
 Date:           $Date: 2011-05-20 12:21:10 $

Function Members (Methods)

public:

	TMrbC2Lynx()
	TMrbC2Lynx(const Char_t* HostName, const Char_t* Server = NULL, const Char_t* LogFile = NULL, Int_t Port = 9010, const Char_t* ServerLog = "cout", Bool_t ConnectFlag = kTRUE)
virtual	~TMrbC2Lynx()
void	TObject::AbstractMethod(const char* method) const
void	AddModule(TMrbNamedX* Module)
M2L_MsgHdr*	AllocMessage(Int_t Length, Int_t Wc, UInt_t What)
virtual void	TObject::AppendPad(Option_t* option = "")
virtual void	TObject::Browse(TBrowser* b)
void	Bye()
Bool_t	CheckAccessToLynxOs(const Char_t* Host, const Char_t* ServerPath)
Bool_t	CheckVersion(TString& Cpu, TString& Lynx, const Char_t* Host = NULL, const Char_t* ServerPath = NULL)
static TClass*	Class()
virtual const char*	TObject::ClassName() const
virtual void	TNamed::Clear(Option_t* option = "")
virtual TObject*	TNamed::Clone(const char* newname = "") const
virtual Int_t	TNamed::Compare(const TObject* obj) const
Bool_t	Connect(Bool_t WaitFlag = kTRUE)
virtual void	TNamed::Copy(TObject& named) const
virtual void	TObject::Delete(Option_t* option = "")MENU
virtual Int_t	TObject::DistancetoPrimitive(Int_t px, Int_t py)
virtual void	TObject::Draw(Option_t* option = "")
virtual void	TObject::DrawClass() constMENU
virtual TObject*	TObject::DrawClone(Option_t* option = "") constMENU
virtual void	TObject::Dump() constMENU
virtual void	TObject::Error(const char* method, const char* msgfmt) const
virtual void	TObject::Execute(const char* method, const char* params, Int_t* error = 0)
virtual void	TObject::Execute(TMethod* method, TObjArray* params, Int_t* error = 0)
virtual void	TObject::ExecuteEvent(Int_t event, Int_t px, Int_t py)
virtual void	TObject::Fatal(const char* method, const char* msgfmt) const
virtual void	TNamed::FillBuffer(char*& buffer)
TC2LVMEModule*	FindModule(const Char_t* ModuleName)
virtual TObject*	TObject::FindObject(const char* name) const
virtual TObject*	TObject::FindObject(const TObject* obj) const
virtual Option_t*	TObject::GetDrawOption() const
static Long_t	TObject::GetDtorOnly()
const Char_t*	GetHost()
virtual const char*	TObject::GetIconName() const
const Char_t*	GetLogFile()
virtual const char*	TNamed::GetName() const
virtual char*	TObject::GetObjectInfo(Int_t px, Int_t py) const
static Bool_t	TObject::GetObjectStat()
virtual Option_t*	TObject::GetOption() const
Int_t	GetPort()
TMrbNamedX*	GetServerLog()
const Char_t*	GetServerName()
const Char_t*	GetServerPath()
TSocket*	GetSocket()
virtual const char*	TNamed::GetTitle() const
virtual UInt_t	TObject::GetUniqueID() const
virtual Bool_t	TObject::HandleTimer(TTimer* timer)
virtual ULong_t	TNamed::Hash() const
void	Help()
virtual void	TObject::Info(const char* method, const char* msgfmt) const
virtual Bool_t	TObject::InheritsFrom(const char* classname) const
virtual Bool_t	TObject::InheritsFrom(const TClass* cl) const
void	InitMessage(M2L_MsgHdr* Hdr, Int_t Length, UInt_t What)
virtual void	TObject::Inspect() constMENU
void	TObject::InvertBit(UInt_t f)
virtual TClass*	IsA() const
Bool_t	IsConnected()
Bool_t	IsDebug()
virtual Bool_t	TObject::IsEqual(const TObject* obj) const
virtual Bool_t	TObject::IsFolder() const
Bool_t	IsNonBlocking()
Bool_t	TObject::IsOnHeap() const
virtual Bool_t	TNamed::IsSortable() const
Bool_t	IsVerbose()
Bool_t	TObject::IsZombie() const
Int_t	Length(M2L_MsgHdr* Hdr)
TMrbLofNamedX*	LofModules()
Bool_t	LogCout()
Bool_t	LogNone()
Bool_t	LogXterm()
virtual void	TNamed::ls(Option_t* option = "") const
void	TObject::MayNotUse(const char* method) const
virtual Bool_t	TObject::Notify()
void	TObject::Obsolete(const char* method, const char* asOfVers, const char* removedFromVers) const
static void	TObject::operator delete(void* ptr)
static void	TObject::operator delete(void* ptr, void* vp)
static void	TObject::operator delete[](void* ptr)
static void	TObject::operator delete[](void* ptr, void* vp)
void*	TObject::operator new(size_t sz)
void*	TObject::operator new(size_t sz, void* vp)
void*	TObject::operator new[](size_t sz)
void*	TObject::operator new[](size_t sz, void* vp)
TNamed&	TNamed::operator=(const TNamed& rhs)
virtual void	TObject::Paint(Option_t* option = "")
virtual void	TObject::Pop()
virtual void	TNamed::Print(Option_t* option = "") const
virtual Int_t	TObject::Read(const char* name)
virtual void	TObject::RecursiveRemove(TObject* obj)
Bool_t	Recv(M2L_MsgHdr* Hdr)
void	TObject::ResetBit(UInt_t f)
virtual void	TObject::SaveAs(const char* filename = "", Option_t* option = "") constMENU
virtual void	TObject::SavePrimitive(ostream& out, Option_t* option = "")
Bool_t	Send(M2L_MsgHdr* Hdr)
void	TObject::SetBit(UInt_t f)
void	TObject::SetBit(UInt_t f, Bool_t set)
virtual void	TObject::SetDrawOption(Option_t* option = "")MENU
static void	TObject::SetDtorOnly(void* obj)
virtual void	TNamed::SetName(const char* name)MENU
virtual void	TNamed::SetNameTitle(const char* name, const char* title)
void	SetNonBlocking(Bool_t Flag = kFALSE)
static void	TObject::SetObjectStat(Bool_t stat)
Bool_t	SetServerLog(const Char_t* Output)
Bool_t	SetServerLog(TMrbC2Lynx::EC2LServerLog Output)
virtual void	TNamed::SetTitle(const char* title = "")MENU
virtual void	TObject::SetUniqueID(UInt_t uid)
virtual void	ShowMembers(TMemberInspector&)
virtual Int_t	TNamed::Sizeof() const
virtual void	Streamer(TBuffer&)
void	StreamerNVirtual(TBuffer& ClassDef_StreamerNVirtual_b)
virtual void	TObject::SysError(const char* method, const char* msgfmt) const
Bool_t	TObject::TestBit(UInt_t f) const
Int_t	TObject::TestBits(UInt_t f) const
virtual void	TObject::UseCurrentStyle()
Bool_t	WaitForConnection()
virtual void	TObject::Warning(const char* method, const char* msgfmt) const
UInt_t	What(M2L_MsgHdr* Hdr)
virtual Int_t	TObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0)
virtual Int_t	TObject::Write(const char* name = 0, Int_t option = 0, Int_t bufsize = 0) const

protected:

virtual void	TObject::DoError(int level, const char* location, const char* fmt, va_list va) const
void	TObject::MakeZombie()
void	Reset()

Data Members

public:

enum EC2LServerLog {	kC2LServerLogNone
	kC2LServerLogCout
	kC2LServerLogXterm
};
enum TObject::EStatusBits {	kCanDelete
	kMustCleanup
	kObjInCanvas
	kIsReferenced
	kHasUUID
	kCannotPick
	kNoContextMenu
	kInvalidObject
};
enum TObject::[unnamed] {	kIsOnHeap
	kNotDeleted
	kZombie
	kBitMask
	kSingleKey
	kOverwrite
	kWriteDelete
};

protected:

Bool_t	fDebugMode	kTRUE if debug, includes verbose=on
TString	fHost	host name
TMrbLofNamedX	fLofModules	list of vme/camac modules connected
TMrbLofNamedX	fLofServerLogs	list of server log modes
TString	fLogFile	where to write log info
TString	TNamed::fName	object identifier
Bool_t	fNonBlocking	non-blocking mode
Int_t	fPort	port number
TMrbNamedX*	fServerLog	where to output server messages
TString	fServerName	server program
TString	fServerPath	where to start server from
TSocket*	fSocket	! connection to server
TString	TNamed::fTitle	object title
Bool_t	fUseXterm	kTRUE if server logs to be shown in a xterm window
Bool_t	fVerboseMode	kTRUE if verbose mode on

Class Charts

Inheritance Inherited Members Includes Libraries

Function documentation

TMrbC2Lynx(const Char_t* HostName, const Char_t* Server = NULL, const Char_t* LogFile = NULL, Int_t Port = 9010, const Char_t* ServerLog = "cout", Bool_t ConnectFlag = kTRUE)

__________________________________________________________________[C++ CTOR]

 Name:           TMrbC2Lynx
 Purpose:        Connect to LynxOs
 Arguments:      Char_t * HostName      -- server host
                 Char_t * Server        -- server path
                 Char_t * LogFile       -- where to write log messages
                 Int_t Port             -- tcp port
                 Char_t * ServerLog     -- where to output server logs
                 Bool_t ConnectFlag     -- try to establish connection
 Results:        --
 Description:    Class constructor

Bool_t Connect(Bool_t WaitFlag = kTRUE)

________________________________________________________________[C++ METHOD]

 Name:           TMrbC2Lynx::Connect
 Purpose:        Connect to server
 Arguments:      Bool_t WaitFlag  -- wait for connection to establish if kTRUE
 Results:        kTRUE/kFALSE
 Exceptions:
 Description:    (Re)Connects to server.
 Keywords:

Bool_t WaitForConnection()

________________________________________________________________[C++ METHOD]

 Name:           TMrbC2Lynx::WaitForConnection
 Purpose:        Connect to server
 Arguments:      --
 Results:        kTRUE/kFALSE
 Exceptions:
 Description:    Wait for connection to establish.
 Keywords:

void Reset()

________________________________________________________________[C++ METHOD]

 Name:           TMrbC2Lynx::Reset
 Purpose:        Reset internal data base
 Arguments:      --
 Results:        --
 Exceptions:
 Description:    Reset data base (protected method).
 Keywords:

Bool_t SetServerLog(const Char_t* Output)

________________________________________________________________[C++ METHOD]

 Name:           TMrbC2Lynx::SetServerLog
 Purpose:        Define output mode
 Arguments:      Char_t * Output   -- output mode
 Results:        kTRUE/kFALSE
 Exceptions:
 Description:    Defines output mode for server logs
 Keywords:

Bool_t SetServerLog(TMrbC2Lynx::EC2LServerLog Output)

________________________________________________________________[C++ METHOD]

 Name:           TMrbC2Lynx::SetServerLog
 Purpose:        Define output mode
 Arguments:      EC2LServerLog Output   -- output mode
 Results:        kTRUE/kFALSE
 Exceptions:
 Description:    Defines output mode for server logs
 Keywords:

Bool_t Send(M2L_MsgHdr* Hdr)

________________________________________________________________[C++ METHOD]

 Name:           TMrbC2Lynx::Send
 Purpose:        Send a message
 Arguments:      M2L_MsgHdr * Hdr  -- (header of) message to be sent
 Results:        kTRUE/kFALSE
 Exceptions:
 Description:    Sends a message over internal socket.
 Keywords:

Bool_t Recv(M2L_MsgHdr* Hdr)

________________________________________________________________[C++ METHOD]

 Name:           TMrbC2Lynx::Recv
 Purpose:        Receive a message
 Arguments:      M2L_MsgHdr * Hdr  -- (header of) message
 Results:        kTRUE/kFALSE
 Exceptions:
 Description:    Sends a message over internal socket.
 Keywords:

void Bye()

________________________________________________________________[C++ METHOD]

 Name:           TMrbC2Lynx::Bye
 Purpose:        Terminate session
 Arguments:      --
 Results:        --
 Exceptions:
 Description:    Sends a bye message to server and terminates connection.
 Keywords:

void InitMessage(M2L_MsgHdr* Hdr, Int_t Length, UInt_t What)

________________________________________________________________[C++ METHOD]

 Name:           TMrbC2Lynx::InitMessage
 Purpose:        Initialize message
 Arguments:      M2L_MsgHdr * Hdr    -- ptr to message (header)
                 Int_t Length        -- message length
                 UInt_t What         -- message type
 Results:        --
 Exceptions:
 Description:    Clears message data and fills header
 Keywords:

M2L_MsgHdr * AllocMessage(Int_t Length, Int_t Wc, UInt_t What)

________________________________________________________________[C++ METHOD]

 Name:           TMrbC2Lynx::AllocMessage
 Purpose:        Allocate message
 Arguments:      Int_t Length        -- message length
                 Int_t Wc            -- length of data (words)
                 UInt_t What         -- message type
 Results:        M2L_MsgHdr * Hdr    -- ptr to message (header)
 Exceptions:
 Description:    Allocates message on heap
 Keywords:

Bool_t CheckAccessToLynxOs(const Char_t* Host, const Char_t* ServerPath)

________________________________________________________________[C++ METHOD]

 Name:           TMrbC2Lynx::CheckAccessToLynxOs
 Purpose:        Check access to file
 Arguments:      Char_t * Host        -- name of ppc host
                 Char_t * Path        -- path to lynxOs server
 Results:        kTRUE/kFALSE
 Exceptions:
 Description:    Checks if path can be seen from lynxOs
 Keywords:

Bool_t CheckVersion(TString& Cpu, TString& Lynx, const Char_t* Host = NULL, const Char_t* ServerPath = NULL)

________________________________________________________________[C++ METHOD]

 Name:           TMrbC2Lynx::CheckVersion
 Purpose:        Check server version
 Arguments:      Char_t * Host        -- name of ppc host
                 Char_t * Path        -- path to lynxOs server
 Results:        kTRUE / kFALSE
                 TString & Cpu        -- cpu version
                 TString & Lynx       -- lynx version
 Exceptions:
 Description:    Checks file on server machine for occurrence of "@#@" strings:
                 @#@CPU=RIOn
                 @#@LynxOs=n.n
 Keywords:

TMrbC2Lynx()

{ this->Reset(); }

~TMrbC2Lynx()

{}

void SetNonBlocking(Bool_t Flag = kFALSE)

{ fNonBlocking = Flag; }

const Char_t * GetHost()

{ return(fHost.Data()); }

const Char_t * GetServerName()

{ return(fServerName.Data()); }

const Char_t * GetServerPath()

{ return(fServerPath.Data()); }