actf 0.0.1
An acute CTF reader
Loading...
Searching...
No Matches
/home/adwe/code/actf/freader.h
Go to the documentation of this file.
1/*
2 * This file is a part of ACTF.
3 *
4 * Copyright (C) 2024 Adam Wendelin <adwe live se>
5 *
6 * ACTF is free software: you can redistribute it and/or modify it
7 * under the terms of the GNU Lesser General Public License as
8 * published by the Free Software Foundation, either version 3 of the
9 * License, or (at your option) any later version.
10 *
11 * ACTF is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
14 * Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with ACTF. If not, see
18 * <https://www.gnu.org/licenses/>.
19 */
20
28#ifndef ACTF_FREADER_H
29#define ACTF_FREADER_H
30
31#include <stdbool.h>
32#include <stddef.h>
33
34#include "event.h"
35
38
53
61
75
79int actf_freader_open_folders(actf_freader *rd, char **paths, size_t len);
80
82int actf_freader_read(actf_freader *rd, actf_event ***evs, size_t *evs_len);
83
86
89
95
106
107#endif /* ACTF_FREADER_H */
Event related methods.
struct actf_event actf_event
An event.
Definition event.h:35
const char * actf_freader_last_error(actf_freader *rd)
int actf_freader_read(actf_freader *rd, actf_event ***evs, size_t *evs_len)
int actf_freader_seek_ns_from_origin(actf_freader *rd, int64_t tstamp)
void actf_freader_free(actf_freader *rd)
Free a reader.
struct actf_event_generator actf_freader_to_generator(actf_freader *rd)
Create an event generator based on a reader.
struct actf_freader actf_freader
CTF2 FS Reader.
Definition freader.h:37
actf_freader * actf_freader_init(struct actf_freader_cfg cfg)
Initialize a CTF2 FS reader.
int actf_freader_open_folders(actf_freader *rd, char **paths, size_t len)
Like actf_freader_open_folder() but allows multiple CTF2 directories to be specified.
int actf_freader_open_folder(actf_freader *rd, char *path)
Open a CTF2 trace directory and sets up generators to read it.
An event generator.
Definition event_generator.h:93
The configuration of a CTF2 FS reader.
Definition freader.h:41
size_t dstream_evs_cap
The number of events used in the buffer for each data stream file.
Definition freader.h:48
size_t muxer_evs_cap
The number of events used in the buffer for the muxer.
Definition freader.h:51
const char * metadata_filename
The name of the metadata file located at path/metadata_filename.
Definition freader.h:45