SerialObj Class Reference

#include <SerialObj.h>

Inheritance diagram for SerialObj:

[legend]List of all members.

Public Types
typedef SerialObj *(*	FactoryFunc )()
Public Member Functions
virtual	~SerialObj ()
bool	Serialize (Serializer *s, SerialInfo *i, bool cache=true) const
Static Public Member Functions
SerialObj *	Instantiate (SerialType type)
void	Register (SerialType type, FactoryFunc f)
bool	IsBroObj (SerialType type)
SerialObj *	Unserialize (Serializer *s, SerialType type, bool cache=true)
Protected Types
typedef std::map< SerialType, FactoryFunc >	FactoryMap
Protected Member Functions
	SerialObj ()
virtual bool	DoSerialize (Serializer *s, SerialInfo *info, SerialType type) const
virtual bool	DoUnserialize (Serializer *s)
virtual const TransientID *	GetTID () const
Static Protected Attributes
FactoryMap *	factories = 0

---

Member Typedef Documentation

typedef SerialObj*(* SerialObj::FactoryFunc)()

Definition at line 117 of file SerialObj.h. Referenced by IsBroObj(), Register(), and SerialTypeRegistrator::SerialTypeRegistrator().

typedef std::map<SerialType, FactoryFunc> SerialObj::FactoryMap [protected]

Definition at line 142 of file SerialObj.h. Referenced by Register().

---

Constructor & Destructor Documentation

virtual SerialObj::~SerialObj (   )  [inline, virtual]

Definition at line 107 of file SerialObj.h. References Instantiate(), and SerialType. {

SerialObj::SerialObj (   )  [inline, protected]

Definition at line 134 of file SerialObj.h. 00135 : SerialObj() { }

---

Member Function Documentation

bool SerialObj::DoSerialize (  Serializer *  s, SerialInfo *  info, SerialType  type )  const [protected, virtual]

Definition at line 108 of file SerialObj.cc. References SER_NONE, SerialType, uint16, and Serializer::Write(). Referenced by Val::Serialize(), BroType::Serialize(), Stmt::Serialize(), Serialize(), Func::Serialize(), and Expr::Serialize(). { assert(type != SER_NONE); return s->Write((uint16)type); }

bool SerialObj::DoUnserialize (  Serializer *  s  )  [protected, virtual]

Reimplemented in Expr, NameExpr, ConstExpr, UnaryExpr, BinaryExpr, CondExpr, AssignExpr, FieldExpr, HasFieldExpr, RecordMatchExpr, RecordCoerceExpr, FlattenExpr, ScheduleExpr, CallExpr, EventExpr, ListExpr, Func, BroFunc, BuiltinFunc, Stmt, ExprListStmt, ExprStmt, IfStmt, SwitchStmt, EventStmt, ForStmt, StmtList, EventBodyList, InitStmt, BroType, TypeList, TableType, SetType, FuncType, RecordType, FileType, EnumType, VectorType, MutableVal, SubNetVal, PatternVal, ListVal, TableVal, RecordVal, and VectorVal. Definition at line 115 of file SerialObj.cc. Referenced by Val::Unserialize(), and Unserialize(). { // Nothing to do. return true; }

virtual const TransientID* SerialObj::GetTID (   )  const [inline, protected, virtual]

Definition at line 140 of file SerialObj.h. Referenced by Serialize(), and Unserialize(). { return 0; }

SerialObj * SerialObj::Instantiate (  SerialType  type  )  [static]

Definition at line 10 of file SerialObj.cc. References factories, fmt(), run_time(), and SerialType. Referenced by Unserialize(), and ~SerialObj(). { FactoryMap::iterator f = factories->find(type); if ( f != factories->end() ) return (SerialObj*) (*f->second)(); run_time(fmt("Unknown object type %d", type)); return 0; }

bool SerialObj::IsBroObj (  SerialType  type  )  [inline, static]

Definition at line 120 of file SerialObj.h. References FactoryFunc, and SER_IS_BRO_OBJ. Referenced by Unserialize(). { return type & SER_IS_BRO_OBJ; }

void SerialObj::Register (  SerialType  type, FactoryFunc  f )  [static]

Definition at line 20 of file SerialObj.cc. References factories, FactoryFunc, FactoryMap, and SerialType. Referenced by SerialTypeRegistrator::SerialTypeRegistrator(). { if ( ! factories ) factories = new FactoryMap; (*factories)[type] = f; }

bool SerialObj::Serialize (  Serializer *  s, SerialInfo *  i, bool  cache = true )  const

Definition at line 28 of file SerialObj.cc. References Serializer::Cache(), DoSerialize(), GetTID(), SerializationCache::Lookup(), SerializationCache::PermanentID, SerializationCache::Register(), SER_NONE, and Serializer::Write(). Referenced by Timer::Serialize(), TCP_EndpointAnalyzer::Serialize(), TCP_Endpoint::Serialize(), TCP_Contents::Serialize(), TCP_Analyzer::Serialize(), Reassembler::Serialize(), and Connection::Serialize(). { if ( cache ) { const TransientID* tid = GetTID(); assert(tid); SerializationCache::PermanentID pid = s->Cache()->Lookup(*tid); if ( pid != SerializationCache::NONE ) return s->Write(false) && s->Write(pid); pid = s->Cache()->Register(this, *tid); if ( ! (s->Write(true) && s->Write(pid)) ) return false; } return DoSerialize(s, i, SER_NONE); }

SerialObj * SerialObj::Unserialize (  Serializer *  s, SerialType  type, bool  cache = true )  [static]

Definition at line 47 of file SerialObj.cc. References Serializer::Cache(), DoUnserialize(), Serializer::Error(), GetTID(), Instantiate(), IsBroObj(), SerializationCache::Lookup(), SerializationCache::PermanentID, Serializer::Read(), Ref(), SerializationCache::Register(), SerialType, and uint16. Referenced by Timer::Unserialize(), TCP_EndpointAnalyzer::Unserialize(), TCP_Endpoint::Unserialize(), TCP_Contents::Unserialize(), TCP_Analyzer::Unserialize(), Reassembler::Unserialize(), and Connection::Unserialize(). { SerializationCache::PermanentID pid = SerializationCache::NONE; if ( cache ) { bool full_obj; if ( ! (s->Read(&full_obj) && s->Read(&pid)) ) return 0; if ( ! full_obj ) { // FIXME: Yet another const_cast to check eventually... SerialObj* obj = const_cast<SerialObj *>(s->Cache()->Lookup(pid)); if ( obj ) { // BroObjs need to be ref'ed. if ( IsBroObj(type) ) Ref((BroObj*) obj); return obj; } s->Error("unknown object referenced"); return 0; } } uint16 stype; if ( ! s->Read(&stype) ) return 0; SerialObj* obj = Instantiate(SerialType(stype)); if ( ! obj ) { s->Error("unknown object type"); return 0; } const TransientID* tid = obj->GetTID(); if ( cache ) { assert(tid); s->Cache()->Register(obj, *tid, pid); } if ( ! obj->DoUnserialize(s) ) return 0; if ( stype & 0x0f00 != type & 0xf00 ) { s->Error("type mismatch"); return 0; } return obj; }

---

Member Data Documentation

SerialObj::FactoryMap * SerialObj::factories = 0 [static, protected]

Definition at line 8 of file SerialObj.cc. Referenced by Instantiate(), and Register().

---

The documentation for this class was generated from the following files:

• SerialObj.h
• SerialObj.cc

---