doxygen changes

This commit is contained in:
mrkraimer
2017-07-12 06:11:29 -04:00
parent 609c887c19
commit 8c7506449b
16 changed files with 509 additions and 221 deletions
@@ -36,7 +36,34 @@
<h1>PvaClientProcess</h1>
<p>
<b>Not Yet Written</b>
pvaClientProcess is a synchronous wrapper for the pvAccess::ChannelProcess API, which is a callback based API.
Thus it is easier to use than pvAccess::ChannelProcess itself.
</p>
<p>An instance of PvaClientProcess is created via a call to one of the followimg:</p>
<pre>
class PvaClientChannel
...
{
...
PvaClientProcessPtr createProcess(std::string const & request = "");
PvaClientProcessPtr createProcess(epics::pvData::PVStructurePtr const & pvRequest);
...
};
<p>An instance of <b>PvaClientProcess/b> connects to a single channel.
<b>PvaClientProcess</b> has both synchronous methods, which block, and non blocking methods.
</p>
<p><b>PvaClientChannel</b> has methods:</p>
<pre>
connect Calls issueConnect and then waitConnect.
issueConnect issues a request to the server to create the server side of ChannelPut.
waitConnect blocks until server responds that it has created the ChannelPut.
process Calls issueProcess and then waitProcess.
issueProcess issues a process request to the server.
waitProcess waits until the server send a message that the process is complete.
</pre>
<p>
Note that <b>issueConnect</b> and <b>issueProcess</b> do not block but all other methods
do block.
</p>
</body>