You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
94 lines
3.1 KiB
94 lines
3.1 KiB
/* Copyright 2016 Alex 'AdUser' Z (ad_user@runbox.com) |
|
* |
|
* This program is free software; you can redistribute it and/or modify |
|
* it under the terms of the GNU General Public License version 2 as |
|
* published by the Free Software Foundation. |
|
*/ |
|
#include <assert.h> |
|
#include <errno.h> |
|
#include <stdbool.h> |
|
#include <stdio.h> |
|
#include <stdlib.h> |
|
#include <stdint.h> |
|
#include <stdarg.h> |
|
#include <string.h> |
|
#include <unistd.h> |
|
|
|
#include "../strlcpy.h" |
|
#include "../fnv.h" |
|
#include "../mod-defs.h" |
|
#include "../mod-api.h" |
|
|
|
/** |
|
* @file |
|
* This header describes module API of type 'source' |
|
* |
|
* Sample workflow of module usage: |
|
* |
|
* @msc |
|
* f2b, source; |
|
* f2b => source [label="create(init)"]; |
|
* f2b << source [label="module handler, cfg_t *cfg"]; |
|
* f2b => source [label="logcb(cfg, cb)"]; |
|
* |||; |
|
* f2b => source [label="config(cfg, param, value)"]; |
|
* f2b << source [label="true"]; |
|
* f2b => source [label="config(cfg, param, value)"]; |
|
* f2b << source [label="true"]; |
|
* f2b => source [label="config(cfg, param, value)"]; |
|
* f2b <<= source [label="logcb(level, char *msg)"]; |
|
* f2b << source [label="false"]; |
|
* |||; |
|
* f2b => source [label="state(cfg)"]; |
|
* f2b << source [label="int"]; |
|
* --- [label="check for MOD_IS_READY flag"]; |
|
* f2b => source [label="start()"]; |
|
* f2b << source [label="true"]; |
|
* --- [label="source is ready to use"]; |
|
* f2b => source [label="next(cfg, buf, sizeof(buf), true)"]; |
|
* f2b << source [label="false"]; |
|
* ... [label="no data this time, try later"]; |
|
* f2b => source [label="next(cfg, buf, sizeof(buf), true)"]; |
|
* f2b << source [label="true"]; |
|
* f2b => source [label="next(cfg, buf, sizeof(buf), false)"]; |
|
* f2b <<= source [label="logcb(level, char *msg)"]; |
|
* f2b << source [label="true"]; |
|
* f2b => source [label="next(cfg, buf, sizeof(buf), false)"]; |
|
* f2b << source [label="false"]; |
|
* ... [label="time passed"]; |
|
* f2b => source [label="stop(cfg)"]; |
|
* f2b << source [label="true"]; |
|
* --- [label="now you may config(), start() or destroy() source"]; |
|
* f2b => source [label="destroy(cfg)"]; |
|
* @endmsc |
|
*/ |
|
|
|
/** |
|
* @brief Allocate resources and start processing |
|
* @param cfg Module handler |
|
* @returns true on success, false on error |
|
*/ |
|
extern bool start(cfg_t *cfg); |
|
/** |
|
* @brief Poll source for new data |
|
* @param cfg Module handler |
|
* @param buf Pointer to buffer for storing result |
|
* @param bufsize Size of buffer above (in bytes) |
|
* @param reset Reset internals to start of list |
|
* @returns false if no new data available, or true otherwise with filling @a buf |
|
*/ |
|
extern uint32_t next(cfg_t *cfg, char *buf, size_t bufsize, bool reset); |
|
/** |
|
* @brief Get statistics for source |
|
* @param cfg Module handler |
|
* @param buf Pointer to buffer for stats report |
|
* @param bufsize Size of buffer above (in bytes) |
|
* @returns true on success, false on error |
|
*/ |
|
extern bool stats(cfg_t *cfg, char *buf, size_t bufsize); |
|
/** |
|
* @brief Deallocate resources, prepare for module destroy |
|
* @param cfg Module handler |
|
* @returns true on success |
|
*/ |
|
extern bool stop(cfg_t *cfg);
|
|
|