From 46d499f0127106e2d2201cdf8ecdd96f46e5c52b Mon Sep 17 00:00:00 2001 From: Michael Davidsaver Date: Sat, 17 Apr 2021 09:04:36 -0700 Subject: [PATCH] doc and version bump to 0.2.0 --- configure/CONFIG_PVXS_VERSION | 4 ++-- documentation/client.rst | 12 ++++++++++++ documentation/releasenotes.rst | 18 +++++++++++++++++- src/pvxs/client.h | 1 + 4 files changed, 32 insertions(+), 3 deletions(-) diff --git a/configure/CONFIG_PVXS_VERSION b/configure/CONFIG_PVXS_VERSION index b9b1973..91b4256 100644 --- a/configure/CONFIG_PVXS_VERSION +++ b/configure/CONFIG_PVXS_VERSION @@ -1,3 +1,3 @@ PVXS_MAJOR_VERSION = 0 -PVXS_MINOR_VERSION = 1 -PVXS_MAINTENANCE_VERSION = 6 +PVXS_MINOR_VERSION = 2 +PVXS_MAINTENANCE_VERSION = 0 diff --git a/documentation/client.rst b/documentation/client.rst index 73aedff..61f9c39 100644 --- a/documentation/client.rst +++ b/documentation/client.rst @@ -176,6 +176,18 @@ the event queue .. doxygenstruct:: pvxs::client::Subscription :members: +Connect +^^^^^^^ + +Request that a Channel be created now which may be used by other Operations, +allowing them to complete more quickly. + +.. doxygenclass:: pvxs::client::ConnectBuilder + :members: + +.. doxygenstruct:: pvxs::client::Connect + :members: + Threading ^^^^^^^^^ diff --git a/documentation/releasenotes.rst b/documentation/releasenotes.rst index 525bf59..f2dde1e 100644 --- a/documentation/releasenotes.rst +++ b/documentation/releasenotes.rst @@ -3,9 +3,25 @@ Release Notes ============= -0.1.6 (UNRELEASED) +0.2.0 (UNRELEASED) ------------------ +* Changes + + * To simplify usage in situations with complex threading, many client methods avoid unnecessary + synchronization with the client worker thread. + Cancellation still synchronizes by default, but this may now be controlled with + the new syncCancel() Builder methods. cf. `pvxs::client::detail::CommonBuilder::syncCancel()`. + +* Additions + + * Add server ignore address list. cf. `pvxs::server::Config::ignoreAddrs`. Configured from $EPICS_PVAS_IGNORE_ADDR_LIST. + * Allow TCP timeout to be configured. + * Add `pvxs::client::Context::connect()` to force Channel creation and retention. + * Add `pvxs::client::Subscription::shared_from_this()` which can be used with eg. `pvxs::MPMCFIFO` (also newly added). + * Add per Server/Context statistical reporting of network bandwidth used by TCP connection, and by Channel. + cf. `pvxs::client::Context::report()` and `pvxs::server::Server::report()`. + 0.1.5 (May 2021) ---------------- diff --git a/src/pvxs/client.h b/src/pvxs/client.h index 8ca2e8b..b2e8334 100644 --- a/src/pvxs/client.h +++ b/src/pvxs/client.h @@ -807,6 +807,7 @@ public: //! Handler to be invoked when channel becomes disconnected. ConnectBuilder& onDisconnect(std::function&& cb) { _onDis = std::move(cb); return *this; } + //! Submit request to connect PVXS_API std::shared_ptr exec(); };