History

TimeSeriesPlatformLibrary: Improved handling of SignalIndexCache instance within DataPublisher

J. Ritchie Carroll committed 7 years ago

Commit a5cbc2b1 parent ad6759018 files · +199 −114Browse files

Unified · Split

18 files
  1. Source/Libraries/TimeSeriesPlatformLibrary/CMakeLists.txt +3 −1
  2. Source/Libraries/TimeSeriesPlatformLibrary/Common/CommonTypes.cpp +28 −0
  3. Source/Libraries/TimeSeriesPlatformLibrary/Common/CommonTypes.h +3 −27
  4. Source/Libraries/TimeSeriesPlatformLibrary/Common/Convert.cpp +4 −5
  5. Source/Libraries/TimeSeriesPlatformLibrary/Common/Convert.h +1 −0
  6. Source/Libraries/TimeSeriesPlatformLibrary/Common/Timer.h +6 −7
  7. Source/Libraries/TimeSeriesPlatformLibrary/README.txt +7 −4
  8. Source/Libraries/TimeSeriesPlatformLibrary/Samples/AdvancedPublish.cpp +12 −12
  9. Source/Libraries/TimeSeriesPlatformLibrary/Samples/SimplePublish.cpp +5 −5
  10. Source/Libraries/TimeSeriesPlatformLibrary/Transport/DataPublisher.cpp +6 −6
  11. Source/Libraries/TimeSeriesPlatformLibrary/Transport/DataPublisher.h +10 −10
  12. Source/Libraries/TimeSeriesPlatformLibrary/Transport/DataSubscriber.h +8 −8
  13. Source/Libraries/TimeSeriesPlatformLibrary/Transport/PublisherInstance.cpp +39 −4
  14. Source/Libraries/TimeSeriesPlatformLibrary/Transport/PublisherInstance.h +24 −3
  15. Source/Libraries/TimeSeriesPlatformLibrary/Transport/SignalIndexCache.cpp +5 −5
  16. Source/Libraries/TimeSeriesPlatformLibrary/Transport/SignalIndexCache.h +2 −2
  17. Source/Libraries/TimeSeriesPlatformLibrary/Transport/SubscriberConnection.cpp +34 −13
  18. Source/Libraries/TimeSeriesPlatformLibrary/Transport/SubscriberConnection.h +2 −2
Source/Libraries/TimeSeriesPlatformLibrary/CMakeLists.txt+3−1
@@ -417,8 +417,10 @@ if ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang") · 416 unmodified lines
417417 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -stdlib=libc++")
418418 endif()
419419
420+set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -Wall")
421+
420422 # Build gsf library
421−add_library (gsf STATIC ${GSF_SOURCE_FILES})
423+add_library (gsf ${GSF_SOURCE_FILES})
422424 target_link_libraries (gsf pthread m z bz2 boost_system boost_thread boost_date_time boost_iostreams)
423425
424426 # Install headers and library
Source/Libraries/TimeSeriesPlatformLibrary/Common/CommonTypes.cpp+28−0
@@ -80,6 +80,34 @@ bool StringComparer::operator()(const std::string& left, const std::string& righ · 79 unmodified lines
8080 return Compare(left, right) < 0;
8181 }
8282
83+uint32_t GSF::WriteBytes(vector<uint8_t>& buffer, const uint8_t* source, const uint32_t offset, const uint32_t length)
84+{
85+ for (uint32_t i = 0; i < length; i++)
86+ buffer.push_back(source[offset + i]);
87+
88+ return length;
89+}
90+
91+uint32_t GSF::WriteBytes(vector<uint8_t>& buffer, const vector<uint8_t>& source)
92+{
93+ const uint32_t length = source.size();
94+
95+ for (uint32_t i = 0; i < length; i++)
96+ buffer.push_back(source[i]);
97+
98+ return length;
99+}
100+
101+uint32_t GSF::WriteBytes(vector<uint8_t>& buffer, const Guid& value)
102+{
103+ const uint8_t* bytes = value.data;
104+
105+ for (uint32_t i = 0; i < 16; i++)
106+ buffer.push_back(bytes[i]);
107+
108+ return 16;
109+}
110+
83111 Guid GSF::NewGuid()
84112 {
85113 return RandomGuidGen();
Source/Libraries/TimeSeriesPlatformLibrary/Common/CommonTypes.h+3−27
@@ -333,33 +333,9 @@ namespace GSF · 332 unmodified lines
333333 return length;
334334 }
335335
336− static uint32_t WriteBytes(std::vector<uint8_t>& buffer, const uint8_t* source, const uint32_t offset, const uint32_t length)
337− {
338− for (uint32_t i = 0; i < length; i++)
339− buffer.push_back(source[offset + i]);
340−
341− return length;
342− }
343−
344− static uint32_t WriteBytes(std::vector<uint8_t>& buffer, const std::vector<uint8_t>& source)
345− {
346− const uint32_t length = source.size();
347−
348− for (uint32_t i = 0; i < length; i++)
349− buffer.push_back(source[i]);
350−
351− return length;
352− }
353−
354− static uint32_t WriteBytes(std::vector<uint8_t>& buffer, const Guid& value)
355− {
356− const uint8_t* bytes = value.data;
357−
358− for (uint32_t i = 0; i < 16; i++)
359− buffer.push_back(bytes[i]);
360−
361− return 16;
362− }
336+ uint32_t WriteBytes(std::vector<uint8_t>& buffer, const uint8_t* source, const uint32_t offset, const uint32_t length);
337+ uint32_t WriteBytes(std::vector<uint8_t>& buffer, const std::vector<uint8_t>& source);
338+ uint32_t WriteBytes(std::vector<uint8_t>& buffer, const Guid& value);
363339
364340 Guid NewGuid();
365341
Source/Libraries/TimeSeriesPlatformLibrary/Common/Convert.cpp+4−5
@@ -25,7 +25,7 @@ · 24 unmodified lines
2525 #include <iomanip>
2626 #include <sstream>
2727 #include <locale>
28−#include <codecvt>
28+#include <boost/locale.hpp>
2929 #include <boost/uuid/uuid_io.hpp>
3030 #include <boost/uuid/string_generator.hpp>
3131 #include <boost/date_time/posix_time/posix_time.hpp>
@@ -36,6 +36,7 @@ · 4 unmodified lines
3636 using namespace std;
3737 using namespace std::chrono;
3838 using namespace boost::uuids;
39+using namespace boost::locale::conv;
3940 using namespace boost::posix_time;
4041 using namespace boost::gregorian;
4142 using namespace GSF;
@@ -270,14 +271,12 @@ std::string GSF::ToString(const TimeSpan& value) · 228 unmodified lines
270271
271272 wstring GSF::ToUTF16(const string& value)
272273 {
273− wstring_convert<codecvt_utf8<wchar_t>, wchar_t> converter;
274− return converter.from_bytes(value);
274+ return utf_to_utf<wchar_t>(value);
275275 }
276276
277277 string GSF::ToUTF8(const wstring& value)
278278 {
279− wstring_convert<codecvt_utf8<wchar_t>, wchar_t> converter;
280− return converter.to_bytes(value);
279+ return utf_to_utf<char>(value);
281280 }
282281
283282 bool GSF::ParseBoolean(const string& value)
Source/Libraries/TimeSeriesPlatformLibrary/Common/Convert.h+1−0
@@ -61,6 +61,7 @@ namespace GSF · 60 unmodified lines
6161 std::string ToString(const TimeSpan& value);
6262
6363 std::wstring ToUTF16(const std::string& value);
64+
6465 std::string ToUTF8(const std::wstring& value);
6566
6667 // Converts an integer value to a hex representation
Source/Libraries/TimeSeriesPlatformLibrary/Common/Timer.h+6−7
@@ -24,6 +24,7 @@ · 23 unmodified lines
2424 #ifndef _TIMER_H
2525 #define _TIMER_H
2626
27+#include <utility>
2728 #include "CommonTypes.h"
2829
2930 namespace GSF
@@ -34,7 +35,7 @@ namespace GSF · 4 unmodified lines
3435 class Timer // NOLINT
3536 {
3637 private:
37− GSF::Thread* m_timerThread;
38+ SharedPtr<GSF::Thread> m_timerThread;
3839 GSF::IOContext m_timerContext;
3940 boost::asio::deadline_timer m_timer;
4041 int32_t m_interval;
@@ -59,7 +60,7 @@ namespace GSF · 18 unmodified lines
5960 return;
6061
6162 // Reset timer thread when context has nothing left to run
62− delete m_timerThread;
63+ m_timerThread.reset();
6364 m_timerThread = nullptr;
6465
6566 // Restart context in preparation for next run
@@ -82,11 +83,11 @@ namespace GSF · 16 unmodified lines
8283 {
8384 }
8485
85− Timer(const int32_t interval, const TimerElapsedCallback& callback, const bool autoReset = false) :
86+ Timer(const int32_t interval, TimerElapsedCallback callback, const bool autoReset = false) :
8687 m_timerThread(nullptr),
8788 m_timer(m_timerContext),
8889 m_interval(interval),
89− m_callback(callback),
90+ m_callback(std::move(callback)),
9091 m_userData(nullptr),
9192 m_autoReset(autoReset),
9293 m_disposing(false)
@@ -96,8 +97,6 @@ namespace GSF · 3 unmodified lines
9697 ~Timer()
9798 {
9899 m_disposing = true;
99− delete m_timerThread;
100− m_timerThread = nullptr;
101100 Stop();
102101 }
103102
@@ -150,7 +149,7 @@ namespace GSF · 46 unmodified lines
150149 m_timer.async_wait(boost::bind(&Timer::TimerElaspsed, this, boost::asio::placeholders::error));
151150
152151 if (m_timerThread == nullptr)
153− m_timerThread = new GSF::Thread(boost::bind(&Timer::TimerThread, this));
152+ m_timerThread = NewSharedPtr<GSF::Thread>(boost::bind(&Timer::TimerThread, this));
154153 }
155154
156155 void Stop()
Source/Libraries/TimeSeriesPlatformLibrary/README.txt+7−4
@@ -22,9 +22,9 @@ GSF Library files: · 21 unmodified lines
2222
2323 Boost Library files:
2424 C:\Projects\boost
25− \boost
26− \libs
27− etc...
25+ \boost
26+ \libs
27+ etc...
2828
2929 If you have an existing Boost installation you can simply create a symbolic
3030 link to the folder, e.g., mklink /D C:\Projects\boost C:\boost_1_66_0
@@ -69,7 +69,7 @@ GNU Make (http://www.gnu.org/software/make/) · 38 unmodified lines
6969
7070 zlib Library, e.g.: sudo apt install zlib1g-dev
7171
72−bzip2 library, e.g.: sudo apt install libbz2-dev
72+bzip2 Library, e.g.: sudo apt install libbz2-dev
7373
7474 Boost C++ Libraries v1.66.0 (http://www.boost.org/)
7575 - Boost.Asio
@@ -98,6 +98,9 @@ and type the following command. · 22 unmodified lines
9898 Using the CMake GUI, you can modify configuration options, such as
9999 building as a shared library or changing the installation directory.
100100
101+To make a debug build, use the following:
102+
103+ cmake -DCMAKE_BUILD_TYPE=Debug
101104
102105 3. Build
103106 --------
Source/Libraries/TimeSeriesPlatformLibrary/Samples/AdvancedPublish.cpp+12−12
@@ -44,7 +44,7 @@ void DisplayClientDisconnected(DataPublisher* source, const SubscriberConnection · 43 unmodified lines
4444 void DisplayStatusMessage(DataPublisher* source, const string& message);
4545 void DisplayErrorMessage(DataPublisher* source, const string& message);
4646 void HandleTemporalSubscriptionRequested(DataPublisher* source, const SubscriberConnectionPtr& connection);
47−void HandleTemporalProcessingIntervalChangeRequested(DataPublisher* source, const SubscriberConnectionPtr& connection);
47+void HandleProcessingIntervalChangeRequested(DataPublisher* source, const SubscriberConnectionPtr& connection);
4848
4949 void LoadMetadataToPublish(vector<DeviceMetadataPtr>& deviceMetadata, vector<MeasurementMetadataPtr>& measurementMetadata, vector<PhasorMetadataPtr>& phasorMetadata)
5050 {
@@ -57,7 +57,7 @@ void LoadMetadataToPublish(vector<DeviceMetadataPtr>& deviceMetadata, vector<Mea · 6 unmodified lines
5757 device1Metadata->UniqueID = NewGuid();
5858 device1Metadata->Longitude = 300;
5959 device1Metadata->Latitude = 200;
60− device1Metadata->FramesPerSecond = 1;
60+ device1Metadata->FramesPerSecond = 30;
6161 device1Metadata->ProtocolName = "GEP";
6262 device1Metadata->UpdatedOn = timestamp;
6363
@@ -136,8 +136,8 @@ void LoadMetadataToPublish(vector<DeviceMetadataPtr>& deviceMetadata, vector<Mea · 72 unmodified lines
136136 //
137137 // This application accepts the port of the publisher via command line argument,
138138 // starts listening for subscriber connections, the displays summary information
139−// about the measurements it publishes. It provides fourteen measurements, i.e.,
140−// PPA:1 through PPA:14
139+// about the measurements it publishes. It provides four manually defined
140+// measurements, i.e., PPA:1 through PPA:4
141141 //
142142 // Measurements are transmitted via the TCP command channel.
143143 int main(int argc, char* argv[])
@@ -213,9 +213,9 @@ bool RunPublisher(uint16_t port) · 69 unmodified lines
213213 Publisher->RegisterStatusMessageCallback(&DisplayStatusMessage);
214214 Publisher->RegisterErrorMessageCallback(&DisplayErrorMessage);
215215 Publisher->RegisterTemporalSubscriptionRequestedCallback(&HandleTemporalSubscriptionRequested);
216− Publisher->RegisterTemporalProcessingIntervalChangeRequestedCallback(&HandleTemporalProcessingIntervalChangeRequested);
216+ Publisher->RegisterProcessingIntervalChangeRequestedCallback(&HandleProcessingIntervalChangeRequested);
217217
218− // Enable temporal subscription support
218+ // Enable temporal subscription support - this allows historical data requests as well as real-time
219219 Publisher->SetSupportsTemporalSubscriptions(true);
220220
221221 // Load metadata to be used for publication
@@ -235,7 +235,7 @@ bool RunPublisher(uint16_t port) · 13 unmodified lines
235235 {
236236 static uint32_t count = MeasurementsToPublish.size();
237237 const int64_t timestamp = ToTicks(UtcNow());
238− vector<Measurement> measurements;
238+ vector<MeasurementPtr> measurements;
239239
240240 measurements.reserve(count);
241241
@@ -243,10 +243,10 @@ bool RunPublisher(uint16_t port) · 1 unmodified line
243243 for (size_t i = 0; i < count; i++)
244244 {
245245 const MeasurementMetadataPtr metadata = MeasurementsToPublish[i];
246− Measurement measurement;
246+ MeasurementPtr measurement = NewSharedPtr<Measurement>();
247247
248− measurement.SignalID = metadata->SignalID;
249− measurement.Timestamp = timestamp;
248+ measurement->SignalID = metadata->SignalID;
249+ measurement->Timestamp = timestamp;
250250
251251 const float64_t randFraction = rand() / randMax;
252252 const float64_t sign = randFraction > 0.5 ? 1.0 : -1.0;
@@ -271,7 +271,7 @@ bool RunPublisher(uint16_t port) · 18 unmodified lines
271271 break;
272272 }
273273
274− measurement.Value = value;
274+ measurement->Value = value;
275275
276276 measurements.push_back(measurement);
277277 }
@@ -330,7 +330,7 @@ void HandleTemporalSubscriptionRequested(DataPublisher* source, const Subscriber · 52 unmodified lines
330330 CompletionTimer->Start();
331331 }
332332
333−void HandleTemporalProcessingIntervalChangeRequested(DataPublisher* source, const SubscriberConnectionPtr& connection)
333+void HandleProcessingIntervalChangeRequested(DataPublisher* source, const SubscriberConnectionPtr& connection)
334334 {
335335 cout << "Client \"" << connection->GetConnectionID() << "\" with subscriber ID " << ToString(connection->GetSubscriberID()) << " has requested to change its temporal processing interval to " << ToString(connection->GetProcessingInterval()) << "ms" << endl << endl;
336336 }
Source/Libraries/TimeSeriesPlatformLibrary/Samples/SimplePublish.cpp+5−5
@@ -135,7 +135,7 @@ bool RunPublisher(uint16_t port) · 134 unmodified lines
135135 {
136136 static uint32_t count = MeasurementsToPublish.size();
137137 const int64_t timestamp = ToTicks(UtcNow());
138− vector<Measurement> measurements;
138+ vector<MeasurementPtr> measurements;
139139
140140 measurements.reserve(count);
141141
@@ -143,11 +143,11 @@ bool RunPublisher(uint16_t port) · 1 unmodified line
143143 for (size_t i = 0; i < count; i++)
144144 {
145145 const MeasurementMetadataPtr metadata = MeasurementsToPublish[i];
146− Measurement measurement;
146+ MeasurementPtr measurement = NewSharedPtr<Measurement>();
147147
148− measurement.SignalID = metadata->SignalID;
149− measurement.Timestamp = timestamp;
150− measurement.Value = float64_t(rand());
148+ measurement->SignalID = metadata->SignalID;
149+ measurement->Timestamp = timestamp;
150+ measurement->Value = float64_t(rand());
151151
152152 measurements.push_back(measurement);
153153 }
Source/Libraries/TimeSeriesPlatformLibrary/Transport/DataPublisher.cpp+6−6
@@ -178,10 +178,10 @@ void DataPublisher::DispatchTemporalSubscriptionRequested(const SubscriberConnec · 177 unmodified lines
178178 Dispatch(&TemporalSubscriptionRequestedDispatcher, reinterpret_cast<uint8_t*>(&connectionReference), 0, sizeof(SubscriberConnection**));
179179 }
180180
181−void DataPublisher::DispatchTemporalProcessingIntervalChangeRequested(const SubscriberConnectionPtr& connection)
181+void DataPublisher::DispatchProcessingIntervalChangeRequested(const SubscriberConnectionPtr& connection)
182182 {
183183 SubscriberConnection* connectionReference = &*connection;
184− Dispatch(&TemporalProcessingIntervalChangeRequestedDispatcher, reinterpret_cast<uint8_t*>(&connectionReference), 0, sizeof(SubscriberConnection**));
184+ Dispatch(&ProcessingIntervalChangeRequestedDispatcher, reinterpret_cast<uint8_t*>(&connectionReference), 0, sizeof(SubscriberConnection**));
185185 }
186186
187187 // Dispatcher function for status messages. Decodes the message and provides it to the user via the status message callback.
@@ -249,13 +249,13 @@ void DataPublisher::TemporalSubscriptionRequestedDispatcher(DataPublisher* sourc · 61 unmodified lines
249249 }
250250 }
251251
252−void DataPublisher::TemporalProcessingIntervalChangeRequestedDispatcher(DataPublisher* source, const std::vector<uint8_t>& buffer)
252+void DataPublisher::ProcessingIntervalChangeRequestedDispatcher(DataPublisher* source, const std::vector<uint8_t>& buffer)
253253 {
254254 SubscriberConnection* connection = *reinterpret_cast<SubscriberConnection**>(const_cast<uint8_t*>(&buffer[0]));
255255
256256 if (source != nullptr)
257257 {
258− const SubscriberConnectionCallback temporalProcessingIntervalChangeRequestedCallback = source->m_temporalProcessingIntervalChangeRequestedCallback;
258+ const SubscriberConnectionCallback temporalProcessingIntervalChangeRequestedCallback = source->m_processingIntervalChangeRequestedCallback;
259259
260260 if (temporalProcessingIntervalChangeRequestedCallback != nullptr)
261261 temporalProcessingIntervalChangeRequestedCallback(source, connection->GetReference());
@@ -880,7 +880,7 @@ void DataPublisher::RegisterTemporalSubscriptionRequestedCallback(const Subscrib · 618 unmodified lines
880880 m_temporalSubscriptionRequestedCallback = temporalSubscriptionRequestedCallback;
881881 }
882882
883−void DataPublisher::RegisterTemporalProcessingIntervalChangeRequestedCallback(const SubscriberConnectionCallback& temporalProcessingIntervalChangeRequestedCallback)
883+void DataPublisher::RegisterProcessingIntervalChangeRequestedCallback(const SubscriberConnectionCallback& processingIntervalChangeRequestedCallback)
884884 {
885− m_temporalProcessingIntervalChangeRequestedCallback = temporalProcessingIntervalChangeRequestedCallback;
885+ m_processingIntervalChangeRequestedCallback = processingIntervalChangeRequestedCallback;
886886 }
Source/Libraries/TimeSeriesPlatformLibrary/Transport/DataPublisher.h+10−10
@@ -104,7 +104,7 @@ namespace Transport · 103 unmodified lines
104104 SubscriberConnectionCallback m_clientConnectedCallback;
105105 SubscriberConnectionCallback m_clientDisconnectedCallback;
106106 SubscriberConnectionCallback m_temporalSubscriptionRequestedCallback;
107− SubscriberConnectionCallback m_temporalProcessingIntervalChangeRequestedCallback;
107+ SubscriberConnectionCallback m_processingIntervalChangeRequestedCallback;
108108
109109 // Dispatchers
110110 void Dispatch(const DispatcherFunction& function);
@@ -114,14 +114,14 @@ namespace Transport · 3 unmodified lines
114114 void DispatchClientConnected(const SubscriberConnectionPtr& connection);
115115 void DispatchClientDisconnected(const SubscriberConnectionPtr& connection);
116116 void DispatchTemporalSubscriptionRequested(const SubscriberConnectionPtr& connection);
117− void DispatchTemporalProcessingIntervalChangeRequested(const SubscriberConnectionPtr& connection);
117+ void DispatchProcessingIntervalChangeRequested(const SubscriberConnectionPtr& connection);
118118
119119 static void StatusMessageDispatcher(DataPublisher* source, const std::vector<uint8_t>& buffer);
120120 static void ErrorMessageDispatcher(DataPublisher* source, const std::vector<uint8_t>& buffer);
121121 static void ClientConnectedDispatcher(DataPublisher* source, const std::vector<uint8_t>& buffer);
122122 static void ClientDisconnectedDispatcher(DataPublisher* source, const std::vector<uint8_t>& buffer);
123123 static void TemporalSubscriptionRequestedDispatcher(DataPublisher* source, const std::vector<uint8_t>& buffer);
124− static void TemporalProcessingIntervalChangeRequestedDispatcher(DataPublisher* source, const std::vector<uint8_t>& buffer);
124+ static void ProcessingIntervalChangeRequestedDispatcher(DataPublisher* source, const std::vector<uint8_t>& buffer);
125125 static int32_t GetColumnIndex(const GSF::Data::DataTablePtr& table, const std::string& columnName);
126126 public:
127127 // Creates a new instance of the data publisher.
@@ -189,18 +189,18 @@ namespace Transport · 61 unmodified lines
189189 // Callback registration
190190 //
191191 // Callback functions are defined with the following signatures:
192− // void ProcessStatusMessage(DataPublisher* source, const string& message)
193− // void ProcessErrorMessage(DataPublisher* source, const string& message)
194− // void ProcessClientConnected(DataPublisher* source, const SubscriberConnectionPtr& connection);
195− // void ProcessClientDisconnected(DataPublisher* source, const SubscriberConnectionPtr& connection);
196− // void ProcessTemporalSubscriptionRequested(DataPublisher* source, const SubscriberConnectionPtr& connection);
197− // void ProcessTemporalProcessingIntervalChangeRequested(DataPublisher* source, const SubscriberConnectionPtr& connection);
192+ // void HandleStatusMessage(DataPublisher* source, const string& message)
193+ // void HandleErrorMessage(DataPublisher* source, const string& message)
194+ // void HandleClientConnected(DataPublisher* source, const SubscriberConnectionPtr& connection);
195+ // void HandleClientDisconnected(DataPublisher* source, const SubscriberConnectionPtr& connection);
196+ // void HandleTemporalSubscriptionRequested(DataPublisher* source, const SubscriberConnectionPtr& connection);
197+ // void HandleProcessingIntervalChangeRequested(DataPublisher* source, const SubscriberConnectionPtr& connection);
198198 void RegisterStatusMessageCallback(const MessageCallback& statusMessageCallback);
199199 void RegisterErrorMessageCallback(const MessageCallback& errorMessageCallback);
200200 void RegisterClientConnectedCallback(const SubscriberConnectionCallback& clientConnectedCallback);
201201 void RegisterClientDisconnectedCallback(const SubscriberConnectionCallback& clientDisconnectedCallback);
202202 void RegisterTemporalSubscriptionRequestedCallback(const SubscriberConnectionCallback& temporalSubscriptionRequestedCallback);
203− void RegisterTemporalProcessingIntervalChangeRequestedCallback(const SubscriberConnectionCallback& temporalProcessingIntervalChangeRequestedCallback);
203+ void RegisterProcessingIntervalChangeRequestedCallback(const SubscriberConnectionCallback& processingIntervalChangeRequestedCallback);
204204
205205 friend class SubscriberConnection;
206206 };
Source/Libraries/TimeSeriesPlatformLibrary/Transport/DataSubscriber.h+8−8
@@ -264,14 +264,14 @@ namespace Transport · 263 unmodified lines
264264 // Callback registration
265265 //
266266 // Callback functions are defined with the following signatures:
267− // void ProcessStatusMessage(DataSubscriber* source, const string& message)
268− // void ProcessErrorMessage(DataSubscriber* source, const string& message)
269− // void ProcessDataStartTime(DataSubscriber* source, int64_t startTime)
270− // void ProcessMetadata(DataSubscriber* source, const vector<uint8_t>& metadata)
271− // void ProcessNewMeasurements(DataSubscriber* source, const vector<MeasurementPtr>& newMeasurements)
272− // void ProcessProcessingComplete(DataSubscriber* source, const string& message)
273− // void ProcessConfigurationChanged(DataSubscriber* source)
274− // void ProcessConnectionTerminated(DataSubscriber* source)
267+ // void HandleStatusMessage(DataSubscriber* source, const string& message)
268+ // void HandleErrorMessage(DataSubscriber* source, const string& message)
269+ // void HandleDataStartTime(DataSubscriber* source, int64_t startTime)
270+ // void HandleMetadata(DataSubscriber* source, const vector<uint8_t>& metadata)
271+ // void HandleNewMeasurements(DataSubscriber* source, const vector<MeasurementPtr>& newMeasurements)
272+ // void HandleProcessingComplete(DataSubscriber* source, const string& message)
273+ // void HandleConfigurationChanged(DataSubscriber* source)
274+ // void HandleConnectionTerminated(DataSubscriber* source)
275275 //
276276 // Metadata is provided to the user as zlib-compressed XML,
277277 // and must be decompressed and interpreted before it can be used.
Source/Libraries/TimeSeriesPlatformLibrary/Transport/PublisherInstance.cpp+39−4
@@ -75,10 +75,10 @@ void PublisherInstance::HandleTemporalSubscriptionRequested(DataPublisher* sourc · 74 unmodified lines
7575 instance->TemporalSubscriptionRequested(connection);
7676 }
7777
78−void PublisherInstance::HandleTemporalProcessingIntervalChangeRequested(DataPublisher* source, const SubscriberConnectionPtr& connection)
78+void PublisherInstance::HandleProcessingIntervalChangeRequested(DataPublisher* source, const SubscriberConnectionPtr& connection)
7979 {
8080 PublisherInstance* instance = static_cast<PublisherInstance*>(source->GetUserData());
81− instance->TemporalProcessingIntervalChangeRequested(connection);
81+ instance->ProcessingIntervalChangeRequested(connection);
8282 }
8383
8484 void PublisherInstance::StatusMessage(const string& message)
@@ -106,7 +106,7 @@ void PublisherInstance::TemporalSubscriptionRequested(const SubscriberConnection · 21 unmodified lines
106106 cout << "Client \"" << connection->GetConnectionID() << "\" with subscriber ID " << ToString(connection->GetSubscriberID()) << " has requested a temporal subscription starting at " << ToString(connection->GetStartTimeConstraint()) << endl << endl;
107107 }
108108
109−void PublisherInstance::TemporalProcessingIntervalChangeRequested(const SubscriberConnectionPtr& connection)
109+void PublisherInstance::ProcessingIntervalChangeRequested(const SubscriberConnectionPtr& connection)
110110 {
111111 cout << "Client \"" << connection->GetConnectionID() << "\" with subscriber ID " << ToString(connection->GetSubscriberID()) << " has requested to change its temporal processing interval to " << ToString(connection->GetProcessingInterval()) << "ms" << endl << endl;
112112 }
@@ -119,7 +119,7 @@ void PublisherInstance::Initialize() · 6 unmodified lines
119119 m_publisher.RegisterClientConnectedCallback(&HandleClientConnected);
120120 m_publisher.RegisterClientDisconnectedCallback(&HandleClientDisconnected);
121121 m_publisher.RegisterTemporalSubscriptionRequestedCallback(&HandleTemporalSubscriptionRequested);
122− m_publisher.RegisterTemporalProcessingIntervalChangeRequestedCallback(&HandleTemporalProcessingIntervalChangeRequested);
122+ m_publisher.RegisterProcessingIntervalChangeRequestedCallback(&HandleProcessingIntervalChangeRequested);
123123
124124 m_initialized = true;
125125 }
@@ -134,6 +134,21 @@ void PublisherInstance::DefineMetadata(const DataSetPtr& metadata) · 8 unmodified lines
134134 m_publisher.DefineMetadata(metadata);
135135 }
136136
137+const DataSetPtr& PublisherInstance::GetMetadata() const
138+{
139+ return m_publisher.GetMetadata();
140+}
141+
142+const DataSetPtr& PublisherInstance::GetFilteringMetadata() const
143+{
144+ return m_publisher.GetFilteringMetadata();
145+}
146+
147+vector<MeasurementMetadataPtr> PublisherInstance::FilterMetadata(const string& filterExpression) const
148+{
149+ return m_publisher.FilterMetadata(filterExpression);
150+}
151+
137152 void PublisherInstance::PublishMeasurements(const vector<Measurement>& measurements)
138153 {
139154 if (!m_initialized)
@@ -150,6 +165,26 @@ void PublisherInstance::PublishMeasurements(const vector<MeasurementPtr>& measur · 10 unmodified lines
150165 m_publisher.PublishMeasurements(measurements);
151166 }
152167
168+const GSF::Guid& PublisherInstance::GetNodeID() const
169+{
170+ return m_publisher.GetNodeID();
171+}
172+
173+void PublisherInstance::SetNodeID(const GSF::Guid& nodeID)
174+{
175+ m_publisher.SetNodeID(nodeID);
176+}
177+
178+SecurityMode PublisherInstance::GetSecurityMode() const
179+{
180+ return m_publisher.GetSecurityMode();
181+}
182+
183+void PublisherInstance::SetSecurityMode(SecurityMode securityMode)
184+{
185+ m_publisher.SetSecurityMode(securityMode);
186+}
187+
153188 bool PublisherInstance::IsMetadataRefreshAllowed() const
154189 {
155190 return m_publisher.IsMetadataRefreshAllowed();
Source/Libraries/TimeSeriesPlatformLibrary/Transport/PublisherInstance.h+24−3
@@ -30,7 +30,7 @@ namespace GSF { · 29 unmodified lines
3030 namespace TimeSeries {
3131 namespace Transport
3232 {
33− class PublisherInstance
33+ class PublisherInstance // NOLINT
3434 {
3535 private:
3636 // Publication members
@@ -46,7 +46,7 @@ namespace Transport · 9 unmodified lines
4646 static void HandleClientConnected(DataPublisher* source, const SubscriberConnectionPtr& connection);
4747 static void HandleClientDisconnected(DataPublisher* source, const SubscriberConnectionPtr& connection);
4848 static void HandleTemporalSubscriptionRequested(DataPublisher* source, const SubscriberConnectionPtr& connection);
49− static void HandleTemporalProcessingIntervalChangeRequested(DataPublisher* source, const SubscriberConnectionPtr& connection);
49+ static void HandleProcessingIntervalChangeRequested(DataPublisher* source, const SubscriberConnectionPtr& connection);
5050
5151 protected:
5252 virtual void StatusMessage(const std::string& message); // Defaults output to cout
@@ -54,7 +54,7 @@ namespace Transport · 1 unmodified line
5454 virtual void ClientConnected(const SubscriberConnectionPtr& connection);
5555 virtual void ClientDisconnected(const SubscriberConnectionPtr& connection);
5656 virtual void TemporalSubscriptionRequested(const SubscriberConnectionPtr& connection);
57− virtual void TemporalProcessingIntervalChangeRequested(const SubscriberConnectionPtr& connection);
57+ virtual void ProcessingIntervalChangeRequested(const SubscriberConnectionPtr& connection);
5858
5959 public:
6060 PublisherInstance(uint16_t port, bool ipV6);
@@ -71,9 +71,30 @@ namespace Transport · 10 unmodified lines
7171 // Define metadata from existing dataset
7272 void DefineMetadata(const GSF::Data::DataSetPtr& metadata);
7373
74+ // Gets primary metadata. This dataset contains all the normalized metadata tables that define
75+ // the available detail about the data points that can be subscribed to by clients.
76+ const GSF::Data::DataSetPtr& GetMetadata() const;
77+
78+ // Gets filtering metadata. This dataset, derived from primary metadata, contains a flattened
79+ // table used to subscribe to a filtered set of points with an expression, e.g.:
80+ // FILTER ActiveMeasurements WHERE SignalType LIKE '%PHA'
81+ const GSF::Data::DataSetPtr& GetFilteringMetadata() const;
82+
83+ // Filters primary MeasurementDetail metadata returning values as measurement metadata records
84+ std::vector<MeasurementMetadataPtr> FilterMetadata(const std::string& filterExpression) const;
85+
7486 void PublishMeasurements(const std::vector<Measurement>& measurements);
7587 void PublishMeasurements(const std::vector<MeasurementPtr>& measurements);
7688
89+ // Node ID defines a unique identification for the DataPublisher
90+ // instance that gets included in published metadata so that clients
91+ // can easily distinguish the source of the measurements
92+ const GSF::Guid& GetNodeID() const;
93+ void SetNodeID(const GSF::Guid& nodeID);
94+
95+ SecurityMode GetSecurityMode() const;
96+ void SetSecurityMode(SecurityMode securityMode);
97+
7798 bool IsMetadataRefreshAllowed() const;
7899 void SetMetadataRefreshAllowed(bool allowed);
79100
Source/Libraries/TimeSeriesPlatformLibrary/Transport/SignalIndexCache.cpp+5−5
@@ -154,12 +154,12 @@ uint32_t SignalIndexCache::GetBinaryLength() const · 153 unmodified lines
154154 return m_binaryLength;
155155 }
156156
157−void SignalIndexCache::RecalculateBinaryLength(const SubscriberConnectionPtr& connection)
157+void SignalIndexCache::RecalculateBinaryLength(const SubscriberConnection& connection)
158158 {
159159 uint32_t binaryLength = 28;
160160
161161 for (size_t i = 0; i < m_signalIDList.size(); i++)
162− binaryLength += 26 + connection->EncodeString(m_sourceList[i]).size();
162+ binaryLength += 26 + connection.EncodeString(m_sourceList[i]).size();
163163
164164 m_binaryLength = binaryLength;
165165 }
@@ -214,7 +214,7 @@ void SignalIndexCache::Parse(const vector<uint8_t>& buffer, Guid& subscriberID) · 48 unmodified lines
214214 // IDs that may need to be parsed in the future...
215215 }
216216
217−void SignalIndexCache::Serialize(const SubscriberConnectionPtr& connection, vector<uint8_t>& buffer)
217+void SignalIndexCache::Serialize(const SubscriberConnection& connection, vector<uint8_t>& buffer)
218218 {
219219 const uint32_t binaryLengthLocation = buffer.size();
220220 uint32_t binaryLength = 28;
@@ -223,7 +223,7 @@ void SignalIndexCache::Serialize(const SubscriberConnectionPtr& connection, vect · 2 unmodified lines
223223 WriteBytes(buffer, uint32_t(0));
224224
225225 // Encode subscriber ID
226− Guid subscriberID = connection->GetSubscriberID();
226+ Guid subscriberID = connection.GetSubscriberID();
227227 SwapGuidEndianness(subscriberID, true);
228228 WriteBytes(buffer, subscriberID);
229229
@@ -242,7 +242,7 @@ void SignalIndexCache::Serialize(const SubscriberConnectionPtr& connection, vect · 12 unmodified lines
242242 WriteBytes(buffer, signalID);
243243
244244 // Encode source
245− vector<uint8_t> sourceBytes = connection->EncodeString(m_sourceList[i]);
245+ vector<uint8_t> sourceBytes = connection.EncodeString(m_sourceList[i]);
246246 EndianConverter::WriteBigEndianBytes(buffer, int32_t(sourceBytes.size()));
247247 WriteBytes(buffer, sourceBytes);
248248
Source/Libraries/TimeSeriesPlatformLibrary/Transport/SignalIndexCache.h+2−2
@@ -85,11 +85,11 @@ namespace Transport · 84 unmodified lines
8585 // a vector size, for an exact size call RecalculateBinaryLength first
8686 uint32_t GetBinaryLength() const;
8787
88− void RecalculateBinaryLength(const SubscriberConnectionPtr& connection);
88+ void RecalculateBinaryLength(const SubscriberConnection& connection);
8989
9090 void Parse(const std::vector<uint8_t>& buffer, Guid& subscriberID);
9191
92− void Serialize(const SubscriberConnectionPtr& connection, std::vector<uint8_t>& buffer);
92+ void Serialize(const SubscriberConnection& connection, std::vector<uint8_t>& buffer);
9393 };
9494
9595 typedef SharedPtr<SignalIndexCache> SignalIndexCachePtr;
Source/Libraries/TimeSeriesPlatformLibrary/Transport/SubscriberConnection.cpp+34−13
@@ -167,7 +167,7 @@ int32_t SubscriberConnection::GetProcessingInterval() const · 166 unmodified lines
167167 void SubscriberConnection::SetProcessingInterval(int32_t value)
168168 {
169169 m_processingInterval = value;
170− m_parent->DispatchTemporalProcessingIntervalChangeRequested(shared_from_this());
170+ m_parent->DispatchProcessingIntervalChangeRequested(shared_from_this());
171171 m_parent->DispatchStatusMessage(m_connectionID + " was assigned a new processing interval of " + ToString(value) + ".");
172172 }
173173
@@ -363,7 +363,7 @@ void SubscriberConnection::Stop() · 189 unmodified lines
363363
364364 void SubscriberConnection::PublishMeasurements(const vector<MeasurementPtr>& measurements)
365365 {
366− if (measurements.empty() || !m_isSubscribed)
366+ if (measurements.empty() || !m_isSubscribed || m_signalIndexCache == nullptr)
367367 return;
368368
369369 if (!m_startTimeSent)
@@ -435,7 +435,13 @@ void SubscriberConnection::HandleSubscribe(uint8_t* data, uint32_t length) · 65 unmodified lines
435435 {
436436 const bool usePayloadCompression = (GetOperationalModes() & OperationalModes::CompressPayloadData) > 0;
437437 const bool useCompactMeasurementFormat = (flags & DataPacketFlags::Compact) > 0;
438+
439+ m_parent->DispatchStatusMessage("About to decode connection string with " + ToString(byteLength) + " bytes...");
440+
438441 const string connectionString = DecodeString(data, index, byteLength);
442+
443+ m_parent->DispatchStatusMessage("Successfully decoded connection string: " + connectionString);
444+
439445 const StringMap<string> settings = ParseKeyValuePairs(connectionString);
440446 string setting;
441447
@@ -474,7 +480,11 @@ void SubscriberConnection::HandleSubscribe(uint8_t* data, uint32_t length) · 32 unmodified lines
474480 // Apply subscriber filter expression and build signal index cache
475481 if (TryGetValue(settings, "inputMeasurementKeys", setting))
476482 {
477− if (!ParseSubscriptionRequest(setting, signalIndexCache))
483+ bool success;
484+
485+ signalIndexCache = ParseSubscriptionRequest(setting, success);
486+
487+ if (!success)
478488 return;
479489 }
480490
@@ -533,7 +543,7 @@ void SubscriberConnection::HandleSubscribe(uint8_t* data, uint32_t length) · 52 unmodified lines
533543 signalCount = signalIndexCache->Count();
534544
535545 // Send updated signal index cache to client with validated rights of the selected input measurement keys
536− SendResponse(ServerResponse::UpdateSignalIndexCache, ServerCommand::Subscribe, SerializeSignalIndexCache(signalIndexCache));
546+ SendResponse(ServerResponse::UpdateSignalIndexCache, ServerCommand::Subscribe, SerializeSignalIndexCache(*signalIndexCache));
537547 }
538548
539549 SetSignalIndexCache(signalIndexCache);
@@ -706,7 +716,7 @@ void SubscriberConnection::HandleUserCommand(uint8_t command, uint8_t* data, uin · 166 unmodified lines
706716 {
707717 }
708718
709−bool SubscriberConnection::ParseSubscriptionRequest(const std::string& filterExpression, SignalIndexCachePtr& signalIndexCache)
719+SignalIndexCachePtr SubscriberConnection::ParseSubscriptionRequest(const string& filterExpression, bool& success)
710720 {
711721 string exceptionMessage, parsingException;
712722 FilterExpressionParserPtr parser = NewSharedPtr<FilterExpressionParser>(filterExpression);
@@ -749,7 +759,9 @@ bool SubscriberConnection::ParseSubscriptionRequest(const std::string& filterExp · 36 unmodified lines
749759
750760 SendResponse(ServerResponse::Failed, ServerCommand::Subscribe, exceptionMessage);
751761 m_parent->DispatchErrorMessage(exceptionMessage);
752− return false;
762+
763+ success = false;
764+ return nullptr;
753765 }
754766
755767 uint32_t charSizeEstimate;
@@ -772,7 +784,7 @@ bool SubscriberConnection::ParseSubscriptionRequest(const std::string& filterExp · 16 unmodified lines
772784 const int32_t signalIDColumn = DataPublisher::GetColumnIndex(activeMeasurements, "SignalID");
773785
774786 // Create a new signal index cache for filtered measurements
775− signalIndexCache = NewSharedPtr<SignalIndexCache>();
787+ SignalIndexCachePtr signalIndexCache = NewSharedPtr<SignalIndexCache>();
776788
777789 for (size_t i = 0; i < rows.size(); i++)
778790 {
@@ -785,7 +797,8 @@ bool SubscriberConnection::ParseSubscriptionRequest(const std::string& filterExp · 6 unmodified lines
785797 signalIndexCache->AddMeasurementKey(uint16_t(i), signalID, source, id, charSizeEstimate);
786798 }
787799
788− return true;
800+ success = true;
801+ return signalIndexCache;
789802 }
790803
791804 void SubscriberConnection::PublishDataPacket(const vector<uint8_t>& packet, const int32_t count)
@@ -970,7 +983,7 @@ void SubscriberConnection::ParseCommand(const ErrorCode& error, uint32_t bytesTr · 178 unmodified lines
970983 ReadCommandChannel();
971984 }
972985
973−std::vector<uint8_t> SubscriberConnection::SerializeSignalIndexCache(const SignalIndexCachePtr& signalIndexCache)
986+std::vector<uint8_t> SubscriberConnection::SerializeSignalIndexCache(SignalIndexCache& signalIndexCache) const
974987 {
975988 vector<uint8_t> serializationBuffer;
976989
@@ -982,8 +995,8 @@ std::vector<uint8_t> SubscriberConnection::SerializeSignalIndexCache(const Signa · 5 unmodified lines
982995 if (!useCommonSerializationFormat)
983996 throw PublisherException("DataPublisher only supports common serialization format");
984997
985− serializationBuffer.reserve(uint32_t(signalIndexCache->GetBinaryLength() * 0.02));
986− signalIndexCache->Serialize(shared_from_this(), serializationBuffer);
998+ serializationBuffer.reserve(uint32_t(signalIndexCache.GetBinaryLength() * 0.02));
999+ signalIndexCache.Serialize(*this, serializationBuffer);
9871000
9881001 if (compressSignalIndexCache && useGZipCompression)
9891002 {
@@ -1232,7 +1245,15 @@ string SubscriberConnection::DecodeString(const uint8_t* data, uint32_t offset, · 242 unmodified lines
12321245 switch (m_encoding)
12331246 {
12341247 case OperationalEncoding::UTF8:
1235− return string(reinterpret_cast<const char*>(data + offset), length / sizeof(char));
1248+ {
1249+ string value {};
1250+ value.reserve(length / sizeof(char));
1251+
1252+ for (size_t i = 0; i < length; i += sizeof(char))
1253+ value.append(1, static_cast<char>(data[offset + i]));
1254+
1255+ return value;
1256+ }
12361257 case OperationalEncoding::Unicode:
12371258 case OperationalEncoding::ANSI:
12381259 swapBytes = !swapBytes;
@@ -1246,7 +1267,7 @@ string SubscriberConnection::DecodeString(const uint8_t* data, uint32_t offset, · 7 unmodified lines
12461267 if (swapBytes)
12471268 value.append(1, EndianConverter::ToLittleEndian<wchar_t>(data, offset + i));
12481269 else
1249− value.append(1, *reinterpret_cast<const wchar_t*>(data + offset + i));
1270+ value.append(1, static_cast<wchar_t>(data[offset + i]));
12501271 }
12511272
12521273 return ToUTF8(value);
Source/Libraries/TimeSeriesPlatformLibrary/Transport/SubscriberConnection.h+2−2
@@ -103,13 +103,13 @@ namespace Transport · 102 unmodified lines
103103 void HandlePublishCommandMeasurements(uint8_t* data, uint32_t length);
104104 void HandleUserCommand(uint8_t command, uint8_t* data, uint32_t length);
105105
106− bool ParseSubscriptionRequest(const std::string& filterExpression, SignalIndexCachePtr& signalIndexCache);
106+ SignalIndexCachePtr ParseSubscriptionRequest(const std::string& filterExpression, bool& success);
107107 void PublishDataPacket(const std::vector<uint8_t>& packet, int32_t count);
108108 bool SendDataStartTime(uint64_t timestamp);
109109 void ReadCommandChannel();
110110 void ReadPayloadHeader(const ErrorCode& error, uint32_t bytesTransferred);
111111 void ParseCommand(const ErrorCode& error, uint32_t bytesTransferred);
112− std::vector<uint8_t> SerializeSignalIndexCache(const SignalIndexCachePtr& signalIndexCache);
112+ std::vector<uint8_t> SerializeSignalIndexCache(SignalIndexCache& signalIndexCache) const;
113113 std::vector<uint8_t> SerializeMetadata(const GSF::Data::DataSetPtr& metadata) const;
114114 GSF::Data::DataSetPtr FilterClientMetadata(const StringMap<GSF::FilterExpressions::ExpressionTreePtr>& filterExpressions) const;
115115

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t