/home/adwe/code/actf/fld_loc.h

Go to the documentation of this file.

/*
 * This file is a part of ACTF.
 *
 * Copyright (C) 2024  Adam Wendelin <adwe live se>
 *
 * ACTF is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * ACTF is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
 * Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with ACTF. If not, see
 * <https://www.gnu.org/licenses/>.
 */

#ifndef ACTF_FLD_LOC_H
#define ACTF_FLD_LOC_H

typedef struct actf_fld_loc actf_fld_loc;

enum actf_fld_loc_origin {
    ACTF_FLD_LOC_ORIGIN_NONE,
    ACTF_FLD_LOC_ORIGIN_PKT_HEADER,
    ACTF_FLD_LOC_ORIGIN_PKT_CTX,
    ACTF_FLD_LOC_ORIGIN_EVENT_HEADER,
    ACTF_FLD_LOC_ORIGIN_EVENT_COMMON_CTX,
    ACTF_FLD_LOC_ORIGIN_EVENT_SPECIFIC_CTX,
    ACTF_FLD_LOC_ORIGIN_EVENT_PAYLOAD,
    ACTF_FLD_LOC_N_ORIGINS,
};
 
/* Returns where the field location procedure should start. */
enum actf_fld_loc_origin actf_fld_loc_origin(const actf_fld_loc *loc);

char **actf_fld_loc_path(const actf_fld_loc *loc);

size_t actf_fld_loc_path_len(const actf_fld_loc *loc);
 
#endif /* ACTF_FLD_LOC_H */