// modifications, original revision:
// root/net: v5-14-00 $: TMessage.h,v 1.9 2005/12/09 15:12:19 rdm
// Author: Fons Rademakers 19/12/96
+//
+// 2009-09-01 updating to revision
+// @(#)root/net:$Id$
+// Streaming problems have been encountered, especially when streaming
+// TObjArrays. As long as there was just one member, the streaming was
+// fine. With several members, internal variables of the objects have
+// been interchanged/mixed. This bug only effected the serialization
+// part, not the restoration of the object.
/*************************************************************************
* Copyright (C) 1995-2000, Rene Brun and Fons Rademakers. *
// to differentiate between the usage of TBuffer or TBufferFile.
#include "TMessage.h"
-#if defined(HAVE_TBUFFERFILE_H)
-#include "TBufferFile.h"
-#endif
-
#ifndef ROOT_MessageTypes
#include "MessageTypes.h"
#endif
+#ifndef ROOT_TBits
+#include "TBits.h"
+#endif
#include "AliHLTLogging.h"
/**
* chain.
* This is the original Root TMessage implementation with a few minor
* modifications.
- * - the AliHLTMessage(void *buf, Int_t bufsize) constructor has been made
- * public in order to be used externally.
+ * - the <tt> AliHLTMessage(void *buf, Int_t bufsize)</tt> constructor has been
+ * made public in order to be used externally.
+ *
+ * The class can be used to extract an object from an input data block, or a
+ * data block received via the HOMER interface or from the file writer.
+ * <pre>
+ * AliHLTMessage msg(buffer, size);
+ * TObject* pObj=msg.ReadObject(msg.GetClass());
+ * </pre>
+ *
+ * A simple test macro for a file can look like
+ * <pre>
+ * const char* filename="myobject.dat";
+ * TString param=filename;
+ * param+="?filetype=raw";
+ * TFile file(param);
+ * if (file.IsZombie()) {
+ * cout << "can not open file " << filename << endl;
+ * return;
+ * }
+ *
+ * TArrayC buffer(file.GetSize());
+ * TArrayC tgtbuffer(file.GetSize());
+ * if (file.ReadBuffer(buffer.GetArray(), buffer.GetSize())) {
+ * cout << "error reading file " << filename << endl;
+ * return;
+ * }
+ *
+ * AliHLTMessage msg(buffer.GetArray(), buffer.GetSize());
+ * TObject* pObj=msg.ReadObject(msg.GetClass());
+ * </pre>
+ *
+ * @see AliHLTRootFileWriterComponent for an easy way to save objects
+ * exported via AliHLTMessage in a ROOT file.
+ *
+ * To serialize an object into a buffer, the normal ROOT TMessage mechanism
+ * can be used.
+ * <pre>
+ * AliHLTMessage msg(kMESS_OBJECT);
+ * msg.WriteObject(pObject);
+ * Int_t iMsgLength=msg.Length();
+ * if (iMsgLength>0) {
+ * msg.SetLength(); // sets the length to the first (reserved) word
+ * char* pMsgBuffer msg.Buffer();
+ * // do something with pMsgBuffer and iMsgLenghth
+ * }
+ * </pre>
*/
class AliHLTMessage
:
-# if defined(ROOT_TBufferFile) || defined(HAVE_TBUFFERFILE_H)
+# if defined(ROOT_TBufferFile)
public TBufferFile,
#else
public TBuffer,
void SetLength() const;
+ void ForceWriteInfo(TVirtualStreamerInfo *info, Bool_t force);
void Forward();
- TClass *GetClass() const { return fClass; }
+ TClass *GetClass() const { return fClass;}
+ void IncrementLevel(TVirtualStreamerInfo* info);
void Reset();
void Reset(UInt_t what) { SetWhat(what); Reset(); }
UInt_t What() const { return fWhat; }
void SetWhat(UInt_t what);
+ void EnableSchemaEvolution(Bool_t enable = kTRUE) { fEvolution = enable; }
+ Bool_t UsesSchemaEvolution() const { return fEvolution; }
void SetCompressionLevel(Int_t level = 1);
Int_t GetCompressionLevel() const { return fCompress; }
Int_t Compress();
Int_t Uncompress();
char *CompBuffer() const { return fBufComp; }
Int_t CompLength() const { return (Int_t)(fBufCompCur - fBufComp); }
+ void WriteObject(const TObject *obj);
+ UShort_t WriteProcessID(TProcessID *pid);
+
+ static void EnableSchemaEvolutionForAll(Bool_t enable = kTRUE);
+ static Bool_t UsesSchemaEvolutionForAll();
+
+ const TList* GetStreamerInfos() const {return fInfos;}
+
+ /**
+ * Helper function to stream an object into an AliHLTMessage
+ * The returned instance must be cleaned by the caller
+ */
+ static AliHLTMessage* Stream(TObject* pSrc, Int_t compression=1, unsigned verbosity=0);
+
+ /**
+ * Helper function to extract an object from a buffer.
+ * The returned object must be cleaned by the caller
+ */
+ static TObject* Extract(const void* pBuffer, unsigned bufferSize, unsigned verbosity=0);
+
+ /**
+ * Helper function to extract an object from a file containing the streamed object.
+ * The returned object must be cleaned by the caller
+ */
+ static TObject* Extract(const char* filename, unsigned verbosity=0);
private:
- UInt_t fWhat; //Message type
- TClass *fClass; //If message is kMESS_OBJECT pointer to object's class
- Int_t fCompress; //Compression level from 0 (not compressed) to 9 (max compression)
- char *fBufComp; //Compressed buffer
- char *fBufCompCur; //Current position in compressed buffer
- char *fCompPos; //Position of fBufCur when message was compressed
+ UInt_t fWhat; //!Message type
+ TClass *fClass; //!If message is kMESS_OBJECT pointer to object's class
+ Int_t fCompress; //!Compression level from 0 (not compressed) to 9 (max compression)
+ char *fBufComp; //!Compressed buffer
+ char *fBufCompCur; //!Current position in compressed buffer
+ char *fCompPos; //!Position of fBufCur when message was compressed
+ char *fBufUncompressed; //!Uncompressed buffer
+ TBits fBitsPIDs; //Array of bits to mark the TProcessIDs uids written to the message
+ TList *fInfos; //Array of TStreamerInfo used in WriteObject
+ Bool_t fEvolution; //True if support for schema evolution required
+
+ static Bool_t fgEvolution; //True if global support for schema evolution required
// AliHLTMessage objects cannot be copied or assigned
AliHLTMessage(const AliHLTMessage &); // not implemented
void operator=(const AliHLTMessage &); // not implemented
- ClassDef(AliHLTMessage,0) // Message buffer class
+ /** the minimum size of a serialized TObject */
+ static const Int_t fgkMinimumSize; //!transient
+
+ /** a default buffer describing an empty message */
+ static UInt_t fgkDefaultBuffer[2]; //!transient
+
+ ClassDef(AliHLTMessage,2) // Message buffer class
};
#endif // ALIHLTMESSAGE_H
git://git.uio.no / u / mrichter / AliRoot.git / blobdiff