disconnect callback

This commit is contained in:
zimoch
2007-11-30 15:33:22 +00:00
parent 1f82b0224a
commit ad4b84fd60

View File

@ -172,6 +172,9 @@ void <a href="#event">eventCallback</a>(StreamIoStatus&nbsp;status);
<div class="indent"><code> <div class="indent"><code>
void <a href="#connect">connectCallback</a>(StreamIoStatus&nbsp;status); void <a href="#connect">connectCallback</a>(StreamIoStatus&nbsp;status);
</code></div> </code></div>
<div class="indent"><code>
void <a href="#connect">disconnectCallback</a>(StreamIoStatus&nbsp;status);
</code></div>
<h3>Other provided methods, attibutes, and types</h3> <h3>Other provided methods, attibutes, and types</h3>
@ -280,6 +283,9 @@ bool disconnect();
<div class="indent"><code> <div class="indent"><code>
void connectCallback(IoStatus&nbsp;status); void connectCallback(IoStatus&nbsp;status);
</code></div> </code></div>
<div class="indent"><code>
void disconnectCallback(IoStatus&nbsp;status);
</code></div>
<p> <p>
Connection should be handled automatically. Connection should be handled automatically.
If the device is disconnected, each attempt to access the If the device is disconnected, each attempt to access the
@ -292,7 +298,8 @@ However, sometimes the client wants to connect or
disconnect explicitely. disconnect explicitely.
To connect, the client calls <code>connectRequest()</code>. To connect, the client calls <code>connectRequest()</code>.
This function should return <code>true</code> immediately This function should return <code>true</code> immediately
or <code>false</code> if the request cannot be accepted. or <code>false</code> if the request cannot be accepted or connection
handling is not supported.
The interface should call <code>connectCallback(StreamIoSuccess)</code> The interface should call <code>connectCallback(StreamIoSuccess)</code>
once the bus could be connected. once the bus could be connected.
If the bus cannot be connected within <code>connecttimeout_ms</code> If the bus cannot be connected within <code>connecttimeout_ms</code>
@ -305,10 +312,14 @@ something wrong with the I/O hardware,
<code>connectCallback(StreamIoFault)</code> may be called. <code>connectCallback(StreamIoFault)</code> may be called.
</p> </p>
<p> <p>
To disconnect, the client calls <code>disconnect()</code>; To disconnect, the client calls <code>disconnectRequest()</code>;
This function should return <code>true</code> immediately or This function should return <code>true</code> immediately or
<code>false</code> if disconnecting is impossible. <code>false</code> if the request cannot be accepted or connection
There is no callback for <code>disconnect()</code>. handling is not supported.
The interface should call <code>connectCallback(StreamIoSuccess)</code>
once the bus is disconnected. There is no timeout for this operation.
If disconnecting is impossible, the interface should call
<code>connectCallback(StreamIoFault)</code>.
</p> </p>
<a name="lock"></a> <a name="lock"></a>