Release notes for 4.6.0

working on issue #56; still problems with monitor

configure/CONFIG_PVACLIENT_VERSION

@@ -0,0 +1,3 @@
+EPICS_PVACLIENT_MAJOR_VERSION = 4
+EPICS_PVACLIENT_MINOR_VERSION = 6
+EPICS_PVACLIENT_MAINTENANCE_VERSION = 0

configure/Makefile

@@ -2,6 +2,8 @@ TOP=..
 
 include $(TOP)/configure/CONFIG
 
+CFG += CONFIG_PVACLIENT_VERSION
+
 TARGETS = $(CONFIG_TARGETS)
 CONFIGS += $(subst ../,,$(wildcard $(CONFIG_INSTALLS)))
 

documentation/RELEASE_NOTES.md

@@ -2,6 +2,12 @@
 
 This document summarizes the changes to the module between releases.
 
+## Release 4.6.0 (EPICS 7.0.3, Jul 2019)
+
+* pvaClient now handles exceptions from the server properly (issue #54).
+* MultiChannel classes now properly handle PV structures that don't have a top-level `value` field (issue #56), and are more tolerant of other missing fields (issue #57).
+
+
 ## Release 4.5.0 (EPICS 7.0.2.2, Apr 2019)
 
 Changes have been made for getDouble, putDouble, getDoubleArray, putDoubleArray, getString, putString, getStringArray, and putStringArray.

src/Makefile

@@ -6,7 +6,7 @@ include $(TOP)/configure/CONFIG
 LIBRARY += pvaClient
 
 # shared library ABI version.
-SHRLIB_VERSION ?= 4.5.0
+SHRLIB_VERSION ?= $(EPICS_PVACLIENT_MAJOR_VERSION).$(EPICS_PVACLIENT_MINOR_VERSION).$(EPICS_PVACLIENT_MAINTENANCE_VERSION)
 
 INC += pv/pvaClient.h
 INC += pv/pvaClientMultiChannel.h

src/pv/pvaClient.h

@@ -1813,6 +1813,7 @@ private:
 
     enum RPCState {rpcIdle,rpcActive,rpcComplete};
     RPCState rpcState;
+    epics::pvData::Status requestStatus;
     double responseTimeout;
     friend class RPCRequesterImpl;
 };

src/pv/pvaClientMultiChannel.h

@@ -360,8 +360,10 @@ public:
     void connect();
     /**
      * @brief Get each channel.
+     *
+     * @param valueOnly use only value for union.
      */
-    void get();
+    void get(bool valueOnly = true);
     /**
      * @brief Get the data from the last get.
      * @return the pvaClientNTMultiData.
@@ -476,10 +478,11 @@ public:
      /**
      * @brief Poll each channel.
      *
+     * @param valueOnly use only value for union.
      * If any has new data it is used to update the double[].
      * @return (false,true) if (no, at least one) value was updated.
      */
-    bool poll();
+    bool poll(bool valueOnly = true);
     /**
      * @brief Wait until poll returns true.
      * @param secondsToWait The time to keep trying.
@@ -551,11 +554,12 @@ public:
      * @brief Set the timeStamp base for computing deltaTimes. 
      */
     void startDeltaTime();
-   
     /**
      * @brief Update NTMultiChannel fields.
+     *
+     * @param valueOnly use only value for union.
      */
-    void endDeltaTime();
+    void endDeltaTime(bool valueOnly = true);
     /**
      * @brief Get the time when the last get was made.
      * @return The timeStamp.
@@ -579,7 +583,6 @@ private:
          PvaClientMultiChannelPtr const &pvaNTMultiChannel,
          PvaClientChannelArray const &pvaClientChannelArray,
          epics::pvData::PVStructurePtr const &  pvRequest);
-    void setStructure(epics::pvData::StructureConstPtr const & structure,size_t index);
     void setPVStructure(
         epics::pvData::PVStructurePtr const &pvStructure,size_t index);
 

src/pvaClientNTMultiData.cpp

@@ -44,10 +44,6 @@ PvaClientNTMultiData::PvaClientNTMultiData(
   gotTimeStamp(false)
 {
     if(PvaClient::getDebug()) cout<< "PvaClientNTMultiData::PvaClientNTMultiData()\n";
-    PVFieldPtr pvValue = pvRequest->getSubField("field.value");
-    if(!pvValue) {
-        throw std::runtime_error("pvRequest did not specify value");
-    }
     topPVStructure.resize(nchannel);
     unionValue.resize(nchannel);
     PVDataCreatePtr pvDataCreate = getPVDataCreate();
@@ -88,18 +84,6 @@ PvaClientNTMultiData::~PvaClientNTMultiData()
     if(PvaClient::getDebug()) cout<< "PvaClientNTMultiData::~PvaClientNTMultiData()\n";
 }
 
-
-void PvaClientNTMultiData::setStructure(StructureConstPtr const & structure,size_t index)
-{
-    FieldConstPtr field = structure->getField("value");
-    if(!field) {
-        string message = "channel "
-           + pvaClientChannelArray[index]->getChannel()->getChannelName()
-           + " does not have top level value field";
-        throw std::runtime_error(message);
-    }
-}
-
 void PvaClientNTMultiData::setPVStructure(
         PVStructurePtr const &pvStructure,size_t index)
 {
@@ -137,7 +121,7 @@ void PvaClientNTMultiData::startDeltaTime()
 }
 
 
-void PvaClientNTMultiData::endDeltaTime()
+void PvaClientNTMultiData::endDeltaTime(bool valueOnly)
 {
     for(size_t i=0; i<nchannel; ++i)
     {
@@ -145,18 +129,41 @@ void PvaClientNTMultiData::endDeltaTime()
         if(!pvst) {
             unionValue[i] = PVUnionPtr();
         } else if(unionValue[i]) {
-            unionValue[i]->set(pvst->getSubField("value"));
+            if(valueOnly) {
+                PVFieldPtr pvValue = pvst->getSubField("value");
+                if(pvValue) {
+                    unionValue[i]->set(pvst->getSubField("value"));
+                } else {
+                    unionValue[i] = PVUnionPtr();
+                }
+            } else {
+                unionValue[i]->set(pvst);
+            }
             if(gotAlarm)
             {
-                severity[i] = pvst->getSubField<PVInt>("alarm.severity")->get();
+                PVIntPtr pvSeverity = pvst->getSubField<PVInt>("alarm.severity");
-                status[i] = pvst->getSubField<PVInt>("alarm.status")->get();
+                PVIntPtr pvStatus = pvst->getSubField<PVInt>("alarm.status");
-                message[i] = pvst->getSubField<PVString>("alarm.message")->get();
+                PVStringPtr pvMessage = pvst->getSubField<PVString>("alarm.message");
+                if(pvSeverity&&pvStatus&&pvMessage) {
+                    severity[i] = pvSeverity->get();
+                    status[i] = pvStatus->get();
+                    message[i] = pvMessage->get();
+                } else {
+                    severity[i] = undefinedAlarm;
+                    status[i] = undefinedStatus;
+                    message[i] = "no alarm field";
+                }
             }
             if(gotTimeStamp)
             {
-                secondsPastEpoch[i] = pvst->getSubField<PVLong>("timeStamp.secondsPastEpoch")->get();
+                PVLongPtr pvEpoch = pvst->getSubField<PVLong>("timeStamp.secondsPastEpoch");
-                nanoseconds[i] = pvst->getSubField<PVInt>("timeStamp.nanoseconds")->get();
+                PVIntPtr pvNano = pvst->getSubField<PVInt>("timeStamp.nanoseconds");
-                userTag[i] = pvst->getSubField<PVInt>("timeStamp.userTag")->get();
+                PVIntPtr pvTag = pvst->getSubField<PVInt>("timeStamp.userTag");
+                if(pvEpoch&&pvNano&&pvTag) {
+                    secondsPastEpoch[i] = pvEpoch->get();
+                    nanoseconds[i] = pvNano->get();
+                    userTag[i] = pvTag->get();
+                }
             }
         } 
     }

src/pvaClientNTMultiGet.cpp

@@ -63,13 +63,10 @@ void PvaClientNTMultiGet::connect()
 {
     pvaClientGet.resize(nchannel);
     shared_vector<epics::pvData::boolean> isConnected = pvaClientMultiChannel->getIsConnected();
-    string request = "value";
-    if(pvRequest->getSubField("field.alarm")) request += ",alarm";
-    if(pvRequest->getSubField("field.timeStamp")) request += ",timeStamp";
     for(size_t i=0; i<nchannel; ++i)
     {
          if(isConnected[i]) {
-               pvaClientGet[i] = pvaClientChannelArray[i]->createGet(request);
+               pvaClientGet[i] = pvaClientChannelArray[i]->createGet(pvRequest);
                pvaClientGet[i]->issueConnect();
          }
     }
@@ -86,7 +83,7 @@ void PvaClientNTMultiGet::connect()
     this->isConnected = true;
 }
 
-void PvaClientNTMultiGet::get()
+void PvaClientNTMultiGet::get(bool valueOnly)
 {
     if(!isConnected) connect();
     shared_vector<epics::pvData::boolean> isConnected = pvaClientMultiChannel->getIsConnected();
@@ -114,7 +111,7 @@ void PvaClientNTMultiGet::get()
               pvaClientNTMultiData->setPVStructure(pvaClientGet[i]->getData()->getPVStructure(),i);
          }
     }
-    pvaClientNTMultiData->endDeltaTime();
+    pvaClientNTMultiData->endDeltaTime(valueOnly);
 }
 
 PvaClientNTMultiDataPtr PvaClientNTMultiGet::getData()

src/pvaClientNTMultiMonitor.cpp

@@ -67,13 +67,10 @@ void PvaClientNTMultiMonitor::connect()
 {
     pvaClientMonitor.resize(nchannel);
     shared_vector<epics::pvData::boolean> isConnected = pvaClientMultiChannel->getIsConnected();
-    string request = "value";
-    if(pvRequest->getSubField("field.alarm")) request += ",alarm";
-    if(pvRequest->getSubField("field.timeStamp")) request += ",timeStamp";
     for(size_t i=0; i<nchannel; ++i)
     {
          if(isConnected[i]) {
-               pvaClientMonitor[i] = pvaClientChannelArray[i]->createMonitor(request);
+               pvaClientMonitor[i] = pvaClientChannelArray[i]->createMonitor(pvRequest);
                pvaClientMonitor[i]->issueConnect();
          }
     }
@@ -94,7 +91,7 @@ void PvaClientNTMultiMonitor::connect()
     this->isConnected = true;
 }
 
-bool PvaClientNTMultiMonitor::poll()
+bool PvaClientNTMultiMonitor::poll(bool valueOnly)
 {
     if(!isConnected) connect();
     bool result = false;
@@ -111,7 +108,7 @@ bool PvaClientNTMultiMonitor::poll()
               }
          }
     }
-    if(result) pvaClientNTMultiData->endDeltaTime();
+    if(result) pvaClientNTMultiData->endDeltaTime(valueOnly);
     return result;
 }
 

src/pvaClientRPC.cpp

@@ -12,6 +12,7 @@
 #include <sstream>
 #include <pv/event.h>
 #include <pv/bitSetUtil.h>
+#include <pv/rpcService.h>
 
 #define epicsExportSharedSymbols
 
@@ -180,6 +181,7 @@ void PvaClientRPC::requestDone(
     PvaClientRPCRequesterPtr req = pvaClientRPCRequester.lock();
     {
         Lock xx(mutex);
+        requestStatus = status;
         if(PvaClient::getDebug()) {
              string channelName("disconnected");
              Channel::shared_pointer chan(channel.lock());
@@ -224,7 +226,7 @@ void PvaClientRPC::connect()
         + channelName
         + " PvaClientRPC::connect "
         + status.getMessage();
-    throw std::runtime_error(message);
+    throw RPCRequestException(Status::STATUSTYPE_ERROR,message);
 }
 
 void PvaClientRPC::issueConnect()
@@ -305,10 +307,18 @@ PVStructure::shared_pointer PvaClientRPC::request(PVStructure::shared_pointer co
         string message = "channel "
             + channelName
             + " PvaClientRPC::request request timeout ";
-        throw std::runtime_error(message);
+        throw RPCRequestException(Status::STATUSTYPE_ERROR,message);
     }
     rpcState = rpcIdle;
-    return pvResponse;
+    if(requestStatus.isOK()) return pvResponse;
+    Channel::shared_pointer chan(channel.lock());
+    string channelName("disconnected");
+    if(chan) channelName = chan->getChannelName();
+    string message = "channel "
+            + channelName
+            + " PvaClientRPC::request status ";
+    message += requestStatus.getMessage();
+    throw RPCRequestException(Status::STATUSTYPE_ERROR,message);
 }