input.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2015, 2017-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_INPUT_H
#define NMSG_INPUT_H
 
typedef enum {
        nmsg_input_type_stream, /*%< NMSG payloads from file or socket */
        nmsg_input_type_pcap,   /*%< pcap packets from file or interface */
        nmsg_input_type_pres,   /*%< presentation form */
        nmsg_input_type_callback,
        nmsg_input_type_json,   /*%< JSON form */
} nmsg_input_type;
 
nmsg_input_t
nmsg_input_open_file(int fd);
 
nmsg_input_t
nmsg_input_open_sock(int fd);
 
nmsg_input_t
nmsg_input_open_zmq(void *s);
 
nmsg_input_t
nmsg_input_open_zmq_endpoint(void *zmq_ctx, const char *ep);
 
nmsg_input_t
nmsg_input_open_callback(nmsg_cb_message_read cb, void *user);
 
nmsg_input_t
nmsg_input_open_null(void);
 
nmsg_input_t
nmsg_input_open_pres(int fd, nmsg_msgmod_t msgmod);
 
nmsg_input_t
nmsg_input_open_json(int fd);
 
nmsg_input_t
nmsg_input_open_pcap(nmsg_pcap_t pcap, nmsg_msgmod_t msgmod);
 
nmsg_res
nmsg_input_close(nmsg_input_t *input);
 
nmsg_res
nmsg_input_loop(nmsg_input_t input, int count, nmsg_cb_message cb, void *user);
 
void
nmsg_input_breakloop(nmsg_input_t input);
 
nmsg_res
nmsg_input_read(nmsg_input_t input, nmsg_message_t *msg);
 
nmsg_res
nmsg_input_read_null(nmsg_input_t input, uint8_t *buf, size_t buf_len,
                     struct timespec *ts, nmsg_message_t **msg, size_t *n_msg);
 
void
nmsg_input_set_filter_msgtype(nmsg_input_t input,
                              unsigned vid, unsigned msgtype);
 
nmsg_res
nmsg_input_set_filter_msgtype_byname(nmsg_input_t input,
                                     const char *vname, const char *mname);
 
void
nmsg_input_set_filter_source(nmsg_input_t input, unsigned source);
 
void
nmsg_input_set_filter_operator(nmsg_input_t input, unsigned operator_);
 
void
nmsg_input_set_filter_group(nmsg_input_t input, unsigned group);
 
nmsg_res
nmsg_input_set_blocking_io(nmsg_input_t input, bool flag);
 
nmsg_res
nmsg_input_set_byte_rate(nmsg_input_t input, size_t rate);
 
nmsg_res
nmsg_input_set_verify_seqsrc(nmsg_input_t input, bool verify);
 
nmsg_res
nmsg_input_get_count_container_received(nmsg_input_t input, uint64_t *count);
 
nmsg_res
nmsg_input_get_count_container_dropped(nmsg_input_t input, uint64_t *count);
 
#endif /* NMSG_INPUT_H */