doc: client operation exceptions
This commit is contained in:
@@ -308,3 +308,7 @@ Misc
|
||||
|
||||
.. doxygenstruct:: pvxs::client::RemoteError
|
||||
:members:
|
||||
|
||||
.. doxygenstruct:: pvxs::client::Timeout
|
||||
|
||||
.. doxygenstruct:: pvxs::client::Interrupted
|
||||
|
||||
+4
-2
@@ -64,12 +64,14 @@ struct PVXS_API Connected : public std::runtime_error
|
||||
const epicsTime time;
|
||||
};
|
||||
|
||||
//! Operation::interrupt() called
|
||||
struct PVXS_API Interrupted : public std::runtime_error
|
||||
{
|
||||
Interrupted();
|
||||
virtual ~Interrupted();
|
||||
};
|
||||
|
||||
//! Operation::wait() exceeded timeout
|
||||
struct PVXS_API Timeout : public std::runtime_error
|
||||
{
|
||||
Timeout();
|
||||
@@ -134,8 +136,8 @@ struct PVXS_API Operation {
|
||||
*
|
||||
* @param timeout Time to wait prior to throwing TimeoutError. cf. epicsEvent::wait(double)
|
||||
* @return result Value. Always empty/invalid for put()
|
||||
* @throws Timeout Timeout exceeded
|
||||
* @throws Interrupted interrupt() called
|
||||
* @throws pvxs::client::Timeout Timeout exceeded
|
||||
* @throws pvxs::client::Interrupted interrupt() called
|
||||
*/
|
||||
virtual Value wait(double timeout) =0;
|
||||
|
||||
|
||||
Reference in New Issue
Block a user