readout_capi.h

Go to the documentation of this file.

 
#pragma once
 
#include <stdint.h>
#include <stddef.h>
 
#ifdef WIN32
// Export symbols if compile flags "READOUT_SHARED" and "READOUT_EXPORT" are set on Windows.
    #ifdef READOUT_SHARED
        #ifdef READOUT_EXPORT
            #define RL_API __declspec(dllexport)
        #else
            #define RL_API __declspec(dllimport)
        #endif
    #else
        // Disable definition if linking statically.
        #define RL_API
    #endif
#else
// Disable definition for non-Win32 systems.
#define RL_API
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define READOUT_CAPI_ABI_VERSION 1
 
RL_API int readout_capi_abi_version(void);
 
RL_API const char * readout_version(void);
 
RL_API const char * readout_last_error(void);
 
enum readout_status {
  READOUT_OK = 0,       
  READOUT_STOPPED = 1,  
  READOUT_ERROR = -1    
};
 
/* ---- replay --------------------------------------------------------------- */
 
typedef struct readout_replay readout_replay_t;
 
RL_API readout_replay_t * readout_replay_create(void);
RL_API void readout_replay_destroy(readout_replay_t * handle);
 
/* Configuration setters mirroring ReplayConfig (replay.h). Each returns
 * READOUT_OK or READOUT_ERROR (NULL handle, invalid value, or bad JSON). */
 
RL_API int readout_replay_set_counting_time(readout_replay_t * handle, double seconds);
RL_API int readout_replay_clear_counting_time(readout_replay_t * handle);
RL_API int readout_replay_set_seed(readout_replay_t * handle, uint32_t seed);
RL_API int readout_replay_set_random_order(readout_replay_t * handle, int enable);
RL_API int readout_replay_set_default_endpoint(readout_replay_t * handle, const char * address, int port);
RL_API int readout_replay_set_chunk_size(readout_replay_t * handle, uint64_t chunk);
RL_API int readout_replay_set_subset(readout_replay_t * handle, uint64_t first, uint64_t number, uint64_t every);
RL_API int readout_replay_clear_subset(readout_replay_t * handle);
RL_API int readout_replay_set_pulse_rate(readout_replay_t * handle, double hz);
RL_API int readout_replay_set_fold_tof(readout_replay_t * handle, int enable);
RL_API int readout_replay_set_senders_json(readout_replay_t * handle, const char * json_text);
 
typedef int (*readout_publish_cb)(void * user_data, uint64_t point,
                                  const char * name, const char * value,
                                  const char * unit_or_null);
typedef int (*readout_point_ready_cb)(void * user_data, uint64_t point);
 
RL_API int readout_replay_run(readout_replay_t * handle, const char * filename,
                              readout_publish_cb publish,
                              readout_point_ready_cb point_ready,
                              void * user_data);
 
RL_API void readout_replay_request_stop(readout_replay_t * handle);
RL_API int readout_replay_stop_requested(const readout_replay_t * handle);
RL_API void readout_replay_reset_stop(readout_replay_t * handle);
 
/* ---- combine --------------------------------------------------------------- */
 
RL_API int64_t readout_validate_collector_file(const char * filename);
 
RL_API int readout_append_collector_files(const char * out_filename,
                                          const char * const * in_filenames, size_t n_in,
                                          int reset_datasets);
 
RL_API int readout_concatenate_collector_files(const char * out_filename,
                                               const char * const * in_filenames, size_t n_in);
 
RL_API int readout_combine_collector_files(const char * out_filename,
                                           const char * const * in_filenames, size_t n_in);
 
#ifdef __cplusplus
} // extern "C"
#endif