https://sourceforge.net/p/sfence/wiki/Object%253AProtocol_Protocol%253ADriverFunction%253ACheck/Recent changes to Object:Protocol_Protocol:DriverFunction:CheckenSat, 16 Mar 2013 22:46:19 -0000https://sourceforge.net/p/sfence/wiki/Object%253AProtocol_Protocol%253ADriverFunction%253ACheck/<div class="markdown_content"><h1 id="fprotocol_protocol_check">fProtocol_Protocol_Check</h1> <h5 id="type">Type:</h5> <div class="codehilite"><pre><span class="k">typedef</span> <span class="k">enum</span> <span class="n">eSFENCE_Bool</span> <span class="n">SFENCECALL</span> <span class="p">(</span><span class="o">*</span><span class="n">fProtocol_Protocol_Check</span><span class="p">)(</span><span class="k">struct</span> <span class="n">sProtocol_Protocol_Intern</span> <span class="o">*</span><span class="n">ps_protocol</span><span class="p">);</span> </pre></div> <h5 id="parameters">Parameters:</h5> <table> <thead> <tr> <th>Parameter</th> <th>Meaning</th> </tr> </thead> <tbody> <tr> <td>ps_protocol</td> <td>pointer of <a class="" href="/p/sfence/wiki/Basic%3ADriverObject%3AIntern/">struct sProtocol_Protocol_Intern</a>.</td> </tr> </tbody> </table> <h5 id="return-value">Return value:</h5> <table> <thead> <tr> <th>Value</th> <th>Meaning</th> </tr> </thead> <tbody> <tr> <td>eSFENCE_Bool_True, eSFENCE_Bool_Success</td> <td>any message can be sent or received</td> </tr> <tr> <td>eSFENCE_Bool_False</td> <td>no message can be sent or received</td> </tr> <tr> <td>eSFENCE_Bool_Fail</td> <td>it means that there was happend some critical error durring checking protocol</td> </tr> </tbody> </table> <h5 id="description">Description:</h5> <p><strong>fProtocol_Protocol_Check</strong> function is used for check protocol state.</p> <h5 id="development">Development:</h5> <p>It is good idea to use this driver function like core protocol function. You can receiving and sending data durring calling of this function.<br /> Return eSFENCE_Bool_Fail when connection failed, nonsense data was received, internal driver error happen or something similar.</p> <h5 id="callers-api-functions">Callers API functions:</h5> <table> <thead> <tr> <th>Caller</th> <th>condition</th> <th>meaning</th> </tr> </thead> <tbody> <tr> <td><a class="" href="/p/sfence/wiki/Object%3AProtocol_Protocol%3AFunction%3ACheck/">Protocol_Protocol_Check</a></td> <td>always</td> <td>protocol check</td> </tr> </tbody> </table></div>SFENCESat, 16 Mar 2013 22:46:19 -0000https://sourceforge.net4a0926dacd84164f71a6ef1424fb4eab874157ad