From OpenSCADAWiki
Public methods:
- TProtocolIn( const string &name ); — Initializing constructor.
- string name( ); — The name of the input session.
- AutoHD<TTransportIn> &srcTr( ) — The transport-source of the opening of the session of the input protocol.
- const string &srcAddr( ) — The sender address; second line contains service part of the address for backward messages.
- virtual unsigned waitReqTm( ); — The request waiting time on the input transport in milliseconds, call after what to the protocol with the empty message — the polling mode. Setting it to zero disable the polling mode.
- virtual void setSrcTr( TTransportIn *vl ) — Setting of the transport-source of the opening of the session of the input protocol.
- virtual void setSrcAddr( const string &vl ); — Setting of the sender address.
- int writeTo( const string &data ); — Sending the messages data backward to the sender, into srcAddr().
- virtual bool mess( const string &request, string &answer ); — transfer of the request data sequence to the protocol object for it parsing accordingly to the protocol implementation. The protocol function should process the request, generate the response in answer and return FALSE in the case of the completeness of the request. If the request is not complete, it is necessary to return TRUE for the transport to indicate the "expectation of the completion", the previous parts of the request should be saved in the context of the protocol object.
- TProtocol &owner( ) const; — The protocol, the owner of input sessions.