Session: document the purpose of sampling_mutex_.

[pulseview.git] / pv / session.hpp

diff --git a/pv/session.hpp b/pv/session.hpp
index 0a8f018cbc1216a898d63d0393f80236cca486f7..ac3d654c63f06a4d70cd82db368bf16383c41453 100644 (file)
--- a/pv/session.hpp
+++ b/pv/session.hpp
@@ -40,6 +40,8 @@
 #include <QObject>
 #include <QString>
 
+#include "util.hpp"
+
 struct srd_decoder;
 struct srd_channel;
 
@@ -144,6 +146,8 @@ private:
 
        void feed_in_meta(std::shared_ptr<sigrok::Meta> meta);
 
+       void feed_in_trigger();
+
        void feed_in_frame_begin();
 
        void feed_in_logic(std::shared_ptr<sigrok::Logic> logic);
@@ -159,7 +163,7 @@ private:
 
        std::vector< std::shared_ptr<view::DecodeTrace> > decode_traces_;
 
-       mutable std::mutex sampling_mutex_;
+       mutable std::mutex sampling_mutex_; //!< Protects access to capture_state_.
        capture_state capture_state_;
 
        mutable boost::shared_mutex signals_mutex_;
@@ -182,6 +186,8 @@ Q_SIGNALS:
 
        void signals_changed();
 
+       void trigger_event(util::Timestamp location);
+
        void frame_began();
 
        void data_received();