From a6f75c10158d59fc016f0a75cd9d365c76d7de12 Mon Sep 17 00:00:00 2001 From: Michael Davidsaver Date: Tue, 27 Jan 2026 14:07:39 -0800 Subject: [PATCH] doc: client operation exceptions --- documentation/client.rst | 4 ++++ src/pvxs/client.h | 6 ++++-- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/documentation/client.rst b/documentation/client.rst index 087bac8..3a563cf 100644 --- a/documentation/client.rst +++ b/documentation/client.rst @@ -308,3 +308,7 @@ Misc .. doxygenstruct:: pvxs::client::RemoteError :members: + +.. doxygenstruct:: pvxs::client::Timeout + +.. doxygenstruct:: pvxs::client::Interrupted diff --git a/src/pvxs/client.h b/src/pvxs/client.h index 75fdc0b..91cde74 100644 --- a/src/pvxs/client.h +++ b/src/pvxs/client.h @@ -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;