Translations:Documents/API/113/en

Public methods:

• TMArchivator( const string &id, const string &db, TElem *cf_el ); — Initializing constructor of the messages' archiver with the ID id, for the storage in the database db with the structure <cf_el>.
• string id( ); — Archiver's ID.
• string workId( ); — Working identifier, it includes the name of the module.
• string name( ); — Archiver's name.
• string dscr( ); — Archiver's description.
• bool toStart( ); — The sign "To start the archiver".
• bool startStat( ); — Archivers' status "Run".
• string &addr( ) const; — Address of the archiver's storage.
• int &level( ); — The level of messages, serviced by the archiver.
• void categ( vector<string> &list ); — Categories (templates) of messages, serviced by the archiver.
• string DB( bool qTop = false ) const; — Storage address of the archiver, qTop for the storage queue top.
• string tbl( ); — Table address of the archiver's DB.
• string fullDB( bool qTop = false ); — The full table address of the archiver's storage, qTop for the storage queue top.
• void setName( const string &vl ); — Setting the archiver's name.
• void setDscr( const string &vl ); — Setting the archiver's description.
• void setToStart( bool vl ); — Setting the sign "To start the archiver".
• void setAddr( const string &vl ); — Setting the address of the archiver's storage.
• void setLevel( int lev ); — Setting the level of messages, serviced by the archiver.
• void setDB( const string &vl, bool qTop = false ); — Setting the storage address of the archiver, qTop for the storage queue top.
• time_t redntTm( ); — Time of the last redundancy operation.
• bool redntUse( ); — Getting the data from the backup station mode.
• void setRedntUse( bool vl ); — Changing of the getting the data from the backup station mode.
• Redundant redntMode( ); — Redundancy mode ("<high>", "<low>", "<optimal>", {ForceStation}), enabling.
• void setRedntMode( Redundant vl ); — Setting of the redundancy mode, enabling.
• string redntRun( ); — Configuration of the preferred execution.
• void setRedntRun( const string &vl ); — Setting the configuration of the preferred execution.
• virtual void redntDataUpdate( ); — Operation of the data receiving from the backup station, called automatically by the service procedure of the redundancy scheme of the subsystem.
• virtual void start( ); — Starting the archiver object, the archiver starts for receiving messages and placing them into the storage.
• virtual void stop( ); — Stopping the archiver object.
• virtual time_t begin( ); — Begin time of the archiver data accordingly with the current state of the storage.
• virtual time_t end( ); — End time of the archiver data accordingly with the current state of the storage.
• virtual bool put( vector<TMess::SRec> &mess, bool force = false ); — Placing the message group mess to the archiver. Returns TRUE on the successful operation. Set force for direct writing to the archiver omit the redundancy.
• virtual time_t get( time_t bTm, time_t eTm, vector<TMess::SRec> &mess, const string &category = "", char level = 0, time_t upTo = 0 ); — Getting the messages to mess from the archiver for the specified filter parameters. Returns time of the request stop, useful for proceeding from this position as the end time, i.e. iteratively digging into the story. The filter specified by the time range [bTm...eTm], category rules, level and limited up to the time upTo. In the absence of a direct definition of the limiting time upTo, this limitation is set to prmInterf_TM — 7 seconds.
• TTypeArchivator &owner( ) const; — Archiver's type – the owner of the messages' archiver.