FreeBSD Manual Pages
sc::MsgStateRecv(3) MPQC sc::MsgStateRecv(3) NAME sc::MsgStateRecv - The MsgStateRecv is an abstract base class that receives objects from nodes in a MessageGrp. SYNOPSIS #include <mstate.h> Inherits sc::MsgStateBufRecv. Inherited by sc::BcastStateRecv, and sc::StateRecv. Public Member Functions MsgStateRecv (const Ref< MessageGrp > &) MsgStateRecv must be initialized with a MessageGrp. int version (const ClassDesc *) Returns the version of the ClassDesc. int get (const ClassDesc **) I only need to override get(ClassDesc**) but C++ will hide all of the other get's so I must override everything. int get (char &r, const char *key=0) These restore data saved with StateOut's put. members. int get (unsigned int &r, const char *key=0) int get (int &r, const char *key=0) int get (float &r, const char *key=0) int get (double &r, const char *key=0) int get (char *&) These restore data saved with StateOut's put. int get (unsigned int *&) int get (int *&) int get (float *&) int get (double *&) Public Member Functions inherited from sc::MsgStateBufRecv MsgStateBufRecv (const Ref< MessageGrp > &) MsgStateBufRecv can be initialized with a MessageGrp. MsgStateBufRecv () Use the default MessageGrp. void set_buffer_size (int) The buffer size of statein and stateout objects that communicate with each other must match. Public Member Functions inherited from sc::StateIn virtual void get_header () Read in the header information. virtual int version (const ClassDesc *) Returns the version of the ClassDesc in the persistent object or -1 if info on the ClassDesc doesn't exist. virtual int getstring (char *&) This restores strings saved with StateOut::putstring. virtual int get (std::string &) This restores a std::string object. virtual int get (char &r, const char *keyword=0) These restore data saved with StateOut's put. members. virtual int get (unsigned int &r, const char *keyword=0) virtual int get (int &r, const char *keyword=0) virtual int get (bool &r, const char *keyword=0) virtual int get (float &r, const char *keyword=0) virtual int get (double &r, const char *keyword=0) virtual int get (char *&) These restore data saved with StateOut's put. virtual int get (unsigned int *&) virtual int get (int *&) virtual int get (float *&) virtual int get (double *&) virtual int get_array_char (char *p, int size) These restore data saved with StateOut's put. virtual int get_array_uint (unsigned int *p, int size) virtual int get_array_int (int *p, int size) virtual int get_array_float (float *p, int size) virtual int get_array_double (double *p, int size) template<class T > int get (typename std::vector< T > &v) Read an STL vector of data. int node_to_node () const True if this is a node to node save/restore. virtual int use_directory () Returns true of this object uses a directory. virtual int tell () Return the current position in the file. virtual void seek (int) Set the current position in the file. virtual int seekable () Return non-zero if seek does anything sensible. int has_directory () const virtual void list_objects (std::ostream &=ExEnv::out0()) List all the objects to the stream. void set_override (const Ref< KeyVal > &kv) Give this StateIn a KeyVal object that is used to override values. const Ref< KeyVal > & override () const Return the KeyVal used to override values. Public Member Functions inherited from sc::DescribedClass DescribedClass (const DescribedClass &) DescribedClass & operator= (const DescribedClass &) ClassDesc * class_desc () const throw () This returns the unique pointer to the ClassDesc corresponding to the given type_info object. const char * class_name () const Return the name of the object's exact type. int class_version () const Return the version of the class. virtual void print (std::ostream &=ExEnv::out0()) const Print the object. Public Member Functions inherited from sc::RefCount int lock_ptr () const Lock this object. int unlock_ptr () const Unlock this object. void use_locks (bool inVal) start and stop using locks on this object refcount_t nreference () const Return the reference count. refcount_t reference () Increment the reference count and return the new count. refcount_t dereference () Decrement the reference count and return the new count. int managed () const void unmanage () Turn off the reference counting mechanism for this object. int managed () const Return 1 if the object is managed. Otherwise return 0. Public Member Functions inherited from sc::Identity Identifier identifier () Return the Identifier for this argument. Additional Inherited Members Protected Member Functions inherited from sc::MsgStateBufRecv int get_array_void (void *, int) virtual void next_buffer ()=0 Specializations must implement next_buffer(). Protected Member Functions inherited from sc::StateIn virtual int get_array_void (void *, int) int push_key (const char *key) void pop_key (int n) const char * key () void get_directory () int directory_location () const void find_and_get_directory () virtual int getobject (Ref< SavableState > &) This is used to restore an object. virtual int dir_getobject (Ref< SavableState > &, const char *name) This restores objects that are listed in the directory. virtual void haveobject (int, const Ref< SavableState > &) When storage has been allocated during object restoration, this routine is called with the object reference number and the pointer to the new storage so getpointer can find the data if it is referenced again. virtual void nextobject (int) A call to nextobject followed by havepointer(int) is equiv to havepointer(int,void**);. virtual void haveobject (const Ref< SavableState > &) void have_classdesc () int need_classdesc () virtual int get (const ClassDesc **) This restores ClassDesc's. Protected Member Functions inherited from sc::RefCount RefCount (const RefCount &) RefCount & operator= (const RefCount &) Protected Attributes inherited from sc::MsgStateBufRecv Ref< MessageGrp > grp int nbuf int ibuf int bufsize char * buffer char * send_buffer int nheader int * nbuf_buffer Protected Attributes inherited from sc::StateIn Ref< KeyVal > override_ TranslateDataIn * translate_ std::map< int, StateInData > ps_ int expected_object_num_ std::map< ClassDescP, int > classidmap_ std::map< int, StateClassData > classdatamap_ int nextclassid_ int node_to_node_ int version_ int date_ char userid_ [9] char format_ Detailed Description The MsgStateRecv is an abstract base class that receives objects from nodes in a MessageGrp. Member Function Documentation int sc::MsgStateRecv::get (char & r, const char * keyword = 0) [virtual] These restore data saved with StateOut's put. members. Reimplemented from sc::StateIn. int sc::MsgStateRecv::get (char *&) [virtual] These restore data saved with StateOut's put. members. The data is allocated by StateIn. Reimplemented from sc::StateIn. int sc::MsgStateRecv::get (const ClassDesc **) [virtual] I only need to override get(ClassDesc**) but C++ will hide all of the other get's so I must override everything. Reimplemented from sc::StateIn. int sc::MsgStateRecv::get (double & r, const char * key = 0) [virtual] Reimplemented from sc::StateIn. int sc::MsgStateRecv::get (double *&) [virtual] Reimplemented from sc::StateIn. int sc::MsgStateRecv::get (float & r, const char * key = 0) [virtual] Reimplemented from sc::StateIn. int sc::MsgStateRecv::get (float *&) [virtual] Reimplemented from sc::StateIn. int sc::MsgStateRecv::get (int & r, const char * key = 0) [virtual] Reimplemented from sc::StateIn. int sc::MsgStateRecv::get (int *&) [virtual] Reimplemented from sc::StateIn. int sc::MsgStateRecv::get (unsigned int & r, const char * key = 0) [virtual] Reimplemented from sc::StateIn. int sc::MsgStateRecv::get (unsigned int *&) [virtual] Reimplemented from sc::StateIn. int sc::MsgStateRecv::version (const ClassDesc *) [virtual] Returns the version of the ClassDesc. This assumes that the version of the remote class is the same as that of the local class. Reimplemented from sc::StateIn. Author Generated automatically by Doxygen for MPQC from the source code. Version 2.3.1 Tue May 13 2025 sc::MsgStateRecv(3)
NAME | SYNOPSIS | Detailed Description | Member Function Documentation | Author
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=sc_MsgStateRecv&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>