libdata-unified-status  1.1.1
Data Structures | Macros | Enumerations | Functions
Clock status

Data Structures

struct  unified_status_clock_t
 Clock status details. More...
 

Macros

#define UNIFIED_STATUS_MAX_CLOCK_DIFFERENTIAL   (-0x7FFFFFFF)
 Maximum (or unknown) clock differential.
 

Enumerations

enum  unified_status_clock_source_t {
  unified_status_clock_source_internal_rtc, unified_status_clock_source_gps, unified_status_clock_source_stream_sync, unified_status_clock_source_ntp,
  unified_status_clock_source_accurate_rtc
}
 Different types of clock source.
 

Functions

int unified_status_read_clock (const char *st, struct unified_status_clock_t *out)
 Interpret a clock status tag. More...
 
void unified_status_write_clock (struct membuf_t *buf, const struct unified_status_clock_t *in)
 Compose a clock status tag. More...
 
int soh_store_get_clock_status (const struct soh_store_t *store, struct iso8601_date *timestamp, struct unified_status_clock_t *clock)
 Retrieve clock status from persistent store object. More...
 

Detailed Description

Per-instrument timing status.

Function Documentation

int unified_status_read_clock ( const char *  st,
struct unified_status_clock_t out 
)

Interpret a clock status tag.

Parameters
stPointer to status data (must coincide with start of tag).
[out]outClock status written here.
Return values
0on success.
-1on error.

Interprets clock status tag at st, storing the result in out.

void unified_status_write_clock ( struct membuf_t *  buf,
const struct unified_status_clock_t in 
)

Compose a clock status tag.

Parameters
bufBuffer to write result into.
inClock status.

Encodes the clock status in in, appending the result onto buf.

int soh_store_get_clock_status ( const struct soh_store_t *  store,
struct iso8601_date *  timestamp,
struct unified_status_clock_t clock 
)

Retrieve clock status from persistent store object.

Parameters
storePersistent storage object.
[out]timestampTimestamp of last update. May be 0.
[out]clockClock information structure. May be 0.
Return values
0on success.
-1on error (no status information seen).