OpenSCADAWiki: Doc/API/part7 ...

7. Ïîäñèñòåìà “Ïðîòîêîëû êîììóíèêàöèîííûõ èíòåðôåéñîâ” (TProtocolS)

Ïîäñèñòåìà «Ïðîòîêîëû êîììóíèêàöèîííûõ èíòåðôåéñîâ» ïðåäñòàâëåíà îáúåêòîì TProtocolS, êîòîðûé ñîäåðæèò, íà óðîâíå ïîäñèñòåìû, ìîäóëüíûå îáúåêòû îòäåëüíûõ ïðîòîêîëîâ TProtocol. Êàæäûé ïðîòîêîë ñîäåðæèò îáúåêòû îòêðûòûõ ñåàíñîâ âõîäÿùèõ ïðîòîêîëîâ TProtocolIn.

Îáúåêò TProtocolS ïðåäîñòàâëÿåò äîñòóï ê âõîäÿùèì è èñõîäÿùèì ïðîòîêîëàì îòäåëüíî âçÿòûõ òèïîâ òðàíñïîðòíûõ ïðîòîêîëîâ. Âíóòðåííÿÿ ñòîðîíà èñõîäÿùåãî ïðîòîêîëà ñòðîèòñÿ ïî ïîòîêîâîìó ïðèíöèïó ñ èíäèâèäóàëüíîé ñòðóêòóðîé ïîòîêà äëÿ êàæäîé ðåàëèçàöèè ïðîòîêîëà.

7.1. Îáúåêò ïîäñèñòåìû «Ïðîòîêîëû êîììóíèêàöèîííûõ èíòåðôåéñîâ» (TProtocolS)

Ïóáëè÷íûå ìåòîäû:

• int subVer( ); -- Âåðñèÿ ïîäñèñòåìû.
• AutoHD<TProtocol> at( const string &id ); -- Ïîäêëþ÷åíèå ê ìîäóëþ ïðîòîêîëà <id>.
• string optDescr( ); -- Ëîêàëèçîâàííàÿ ïîìîùü ïî îïöèÿì êîìàíäíîé ñòðîêè è ïàðàìåòðàì êîíôèãóðàöèîííîãî ôàéëà.

7.2. Ìîäóëüíûé îáúåêò ïðîòîêîëà (TProtocol)

Ïóáëè÷íûå ìåòîäû:

• void list( vector<string> &list ); -- Ñïèñîê îòêðûòûõ âõîäÿùèõ ñåàíñîâ.
• bool openStat( const string &name ); -- Ïðîâåðêà íà îòêðûòîñòü âõîäÿùåãî ñåàíñà ñ óêàçàííûì èìåíåì.
• void open( const string &name ); -- Îòêðûòèå âõîäÿùåãî ñåàíñà.
• void close( const string &name ); -- Çàêðûòèå âõîäÿùåãî ñåàíñà.
• AutoHD<TProtocolIn> at( const string &name ); -- Ïîäêëþ÷åíèå ê îòêðûòîìó âõîäÿùåìó ñåàíñó.
• virtual void outMess( XMLNode &io, TTransportOut &tro ); -- Îòïðàâêà äàííûõ â äåðåâå XML <in> ïîñðåäñòâîì äàííîãî ïðîòîêîëà è òðàíñïîðòà <tro>.

7.3. Îáúåêò ñåàíñà âõîäÿùåãî ïðîòîêîëà (TProtocolIn)

Ïóáëè÷íûå ìåòîäû:

• TProtocolIn( const string &name ); -- Èíèöèàëèçèðóþùèé êîíñòðóêòîð.
• string &name( ); -- Èìÿ âõîäÿùåãî ñåàíñà.
• virtual bool mess( const string &request, string &answer, const string &sender ); -- Ïåðåäà÷à íåñòðóêòóðèðîâàííûõ äàííûõ íà îáðàáîòêó ïðîòîêîëó.
• TProtocol &owner( ); -- Ïðîòîêîë – âëàäåëåö âõîäÿùèì ñåàíñîì.