Difference between revisions of "Translations:Documents/API/137/en"

'''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.
* ''TVariant prm( const string &id, const TVariant &val = TVariant(), bool toWr = false );'' — Getting for value the addition parameter ''id'' with default one ''val'', or setting to the value ''val'' at ''toWr''. The additional parameters can store the connection time parameters at pointing ''id'' in the form "{id}\n{SRC}[\n{NAME}[\n{HELP}]]". The additional parameters stored in XML of the configuration field "A_PRMS".
* ''TVariant conPrm( const string &id, const TVariant &val = TVariant(), const string &cfg = "" );'' — Getting for value the connection time parameter ''id'' and setting the parameter at specifying the value ''val''. It uses now [[#TCntrNode|TCntrNode]]::property() as the objects container in the "con" group. If the connection time parameter also is a configuration from an external source, you specify the argument ''cfg'' in the form "{SRC}[\n{NAME}[\n{HELP}]]". Configuration of the external sources is read only by this function with setting the value ''val'' and configuration ''cfg'' once at initialisation, all changes for value the configuration performed by user from control interface of the transport.
* ''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 clearConPrm( const string &id = "" );'' — Clearing the connection time parameter ''id'' at non empty, all ones at empty and the external source configuration at "CFG:". It uses now [[#TCntrNode|TCntrNode]]::property() as the objects container in the "con" group.
* ''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''.
* ''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.
* ''TTypeTransport &owner( ) const;'' — Transport's type – the owner of the input transport.