gSROData.h File Reference

Transport types for the SRO interfaces, upcoming in the next release. More...

#include <chrono>
#include <cstddef>
#include <cstdint>
#include <functional>
#include <memory>
#include <optional>

Include dependency graph for gSROData.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
class	GSROData
	Base for implementation-defined payload and frame contents. More...
struct	GSROEventContext
	Context passed to worker digitizers. Event IDs restart at zero for each run invocation. More...
struct	GSROPayload
	One worker-produced contribution, transferred by move to its destination crate. More...
struct	GSROFrame
	An implementation-produced frame, transferred by move to the output sink. More...
struct	GSROEndContext
	Input-delivery state passed to the implementation at orderly shutdown. More...

Typedefs
using	GSROCrateId = std::uint32_t
using	GSROEventId = std::uint64_t
using	GSROTime = std::chrono::duration<std::int64_t, std::nano>
using	GSROEmit = std::function<void(GSROCrateId, GSROTime, std::unique_ptr<const GSROData>)>
	Immediate worker dispatch; never retain this callback beyond stream_hit. The action assigns sequence IDs.

Enumerations
enum class	GSROEndReason { completed , interrupted }

Detailed Description

Payload production belongs to worker digitizers; framing, electronics response, and encoding belong to the experiment's implementation.

Definition in file gSROData.h.

Typedef Documentation

GSROCrateId

using GSROCrateId = std::uint32_t

Definition at line 18 of file gSROData.h.

GSROEmit

using GSROEmit = std::function<void(GSROCrateId, GSROTime, std::unique_ptr<const GSROData>)>

Definition at line 46 of file gSROData.h.

GSROEventId

using GSROEventId = std::uint64_t

Definition at line 19 of file gSROData.h.

GSROTime

using GSROTime = std::chrono::duration<std::int64_t, std::nano>

Definition at line 20 of file gSROData.h.

Enumeration Type Documentation

GSROEndReason

enum class GSROEndReason

strong

Enumerator
completed
interrupted

Definition at line 82 of file gSROData.h.