From OpenSCADAWiki
Revision as of 10:57, 8 November 2022 by FuzzyBot (Talk | contribs) (Importing a new version from external source)
Public methods:
- TTransportIn( const string &id, const string &db, TElem *el ); — Initializing constructor.
- string id( ); — Transport's Id.
- string workId( ); — Full ID including the ID of the module.
- string name( ); — Transport's name.
- string dscr( ); — Transport's description.
- string addr( ) const; — Address.
- string protocols( ); — Linked transport protocols.
- virtual unsigned keepAliveReqs( ); — Maximum Keep Alive requests.
- virtual unsigned keepAliveTm( ); — Keep Alive time.
- virtual string getStatus( ); — Getting the status of the input transport.
- bool toStart( ); — The sign "To start".
- bool startStat( ); — The status "Running".
- string DB( bool qTop = false ) const; — Transport's storage address, qTop for the storage queue top.
- string tbl( ) const; — Transport's DB table.
- string fullDB( bool qTop = false ) const; — Full name of the transport's storage table, qTop for the storage queue top.
- void setName( const string &inm ); — Setting the name of transport in inm.
- void setDscr( const string &idscr ); — Setting the description of transport in idscr.
- void setAddr( const string &addr ); — Setting the address of transport in addr.
- void setProtocols( const string &prt ); — Setting of the linked transport protocols.
- void setToStart( bool val ); — Setting of the sign "To start".
- void setDB( const string &vl, bool qTop = false ); — Setting of the transport's storage address, qTop for the storage queue top.
- virtual void start( ); — Start of the transport.
- virtual void stop( ); — Stop of the transport.
- virtual int writeTo( const string &sender, const string &data ); — Sending data backward to the sender.
Deprecated mostly and replaced by the polling mode of the input transport protocol, Initially implemented in transports with support of the initiative sending, not only at a request.
- vector<AutoHD<TTransportOut> > associateTrs( bool checkForCleanDisabled = false ); — The associated output transports massive, created by the input transport for typical requests to the connection initiator. Set checkForCleanDisabled for prior checking and clean up disabled ones.
- AutoHD<TTransportOut> associateTr( const string &id ); — Getting the associated output transport at that connection ID.
- int logLen( ); — length of the IO log.
- void setLogLen( int vl ); — set length of the IO log.
- void pushLogMess( const string &vl, const string &data = "", int dataDir = 0 ); — push the message vl with the data in the direction dataDir to the log in the format "{vl}\n{data}".
- TTypeTransport &owner( ) const; — Transport's type – the owner of the input transport.