io.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2019 by Farsight Security, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef NMSG_IO_H
#define NMSG_IO_H
 
#include <nmsg/input.h>
#include <nmsg/output.h>
 
typedef enum {
        nmsg_io_close_type_eof,         /*%< end of file */
        nmsg_io_close_type_count,       /*%< payload count reached */
        nmsg_io_close_type_interval     /*%< interval elapsed */
} nmsg_io_close_type;
 
typedef enum {
        nmsg_io_io_type_input,          /*%< close event input */
        nmsg_io_io_type_output          /*%< close event output */
} nmsg_io_io_type;
 
typedef enum {
        nmsg_io_output_mode_stripe,     /*%< stripe payloads across output */
        nmsg_io_output_mode_mirror      /*%< mirror payloads across output */
} nmsg_io_output_mode;
 
struct nmsg_io_close_event {
        union {
                nmsg_input_t    *input;         /*%< pointer to input stream */
                nmsg_output_t   *output;        /*%< pointer to output stream */
        };
        union {
                nmsg_input_type input_type;     /*%< type of 'input' field */
                nmsg_output_type output_type;   /*%< type of 'output' field */
        };
        nmsg_io_t               io;         /*%< this nmsg_io loop */
        nmsg_io_io_type         io_type;    /*%< whether 'input' or 'output' */
        nmsg_io_close_type      close_type; /*%< why the stream was closed */
        void                    *user;      /*%< caller-provided user pointer */
};
 
typedef void (*nmsg_io_close_fp)(struct nmsg_io_close_event *ce);
 
typedef void (*nmsg_io_user_fp)(unsigned threadno, void *user);
 
nmsg_io_t
nmsg_io_init(void);
 
nmsg_res
nmsg_io_add_filter(nmsg_io_t io, nmsg_filter_message_fp fp, void *data);
 
nmsg_res
nmsg_io_add_filter_module(nmsg_io_t io, const char *name,
                          const void *param, const size_t len_param);
 
nmsg_res
nmsg_io_add_input(nmsg_io_t io, nmsg_input_t input, void *user);
 
nmsg_res
nmsg_io_add_input_channel(nmsg_io_t io, const char *chan, void *user);
 
nmsg_res
nmsg_io_add_input_zmq_channel(nmsg_io_t io, void *zmq_ctx, const char *chan, void *user);
 
nmsg_res
nmsg_io_add_input_sockspec(nmsg_io_t io, const char *sockspec, void *user);
 
nmsg_res
nmsg_io_add_input_fname(nmsg_io_t io, const char *fname, void *user);
 
nmsg_res
nmsg_io_add_output(nmsg_io_t io, nmsg_output_t output, void *user);
 
nmsg_res
nmsg_io_loop(nmsg_io_t io);
 
void
nmsg_io_breakloop(nmsg_io_t io);
 
void
nmsg_io_destroy(nmsg_io_t *io);
 
unsigned
nmsg_io_get_num_inputs(nmsg_io_t io);
 
unsigned
nmsg_io_get_num_outputs(nmsg_io_t io);
 
void
nmsg_io_set_close_fp(nmsg_io_t io, nmsg_io_close_fp close_fp);
 
void
nmsg_io_set_atstart_fp(nmsg_io_t io, nmsg_io_user_fp user_fp, void *user);
 
void
nmsg_io_set_atexit_fp(nmsg_io_t io, nmsg_io_user_fp user_fp, void *user);
 
void
nmsg_io_set_count(nmsg_io_t io, unsigned count);
 
void
nmsg_io_set_debug(nmsg_io_t io, int debug);
 
void
nmsg_io_set_filter_policy(nmsg_io_t io, const nmsg_filter_message_verdict policy);
 
void
nmsg_io_set_interval(nmsg_io_t io, unsigned interval);
 
void
nmsg_io_set_interval_randomized(nmsg_io_t io, bool randomized);
 
void
nmsg_io_set_output_mode(nmsg_io_t io, nmsg_io_output_mode output_mode);
 
nmsg_res
nmsg_io_get_stats(nmsg_io_t io, uint64_t *sum_in, uint64_t *sum_out, uint64_t *container_recvs, uint64_t *container_drops);
 
 
#endif /* NMSG_IO_H */