suricata
output-streaming.h
Go to the documentation of this file.
1 /* Copyright (C) 2007-2022 Open Information Security Foundation
2  *
3  * You can copy, redistribute or modify this Program under the terms of
4  * the GNU General Public License version 2 as published by the Free
5  * Software Foundation.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * version 2 along with this program; if not, write to the Free Software
14  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
15  * 02110-1301, USA.
16  */
17 
18 /**
19  * \file
20  *
21  * \author Victor Julien <victor@inliniac.net>
22  *
23  * Streaming Logger Output registration functions
24  */
25 
26 #ifndef __OUTPUT_STREAMING_H__
27 #define __OUTPUT_STREAMING_H__
28 
29 
30 #define OUTPUT_STREAMING_FLAG_OPEN 0x01
31 #define OUTPUT_STREAMING_FLAG_CLOSE 0x02
32 #define OUTPUT_STREAMING_FLAG_TOSERVER 0x04
33 #define OUTPUT_STREAMING_FLAG_TOCLIENT 0x08
34 #define OUTPUT_STREAMING_FLAG_TRANSACTION 0x10
35 
39 };
40 
41 /** streaming logger function pointer type */
42 typedef int (*StreamingLogger)(ThreadVars *, void *thread_data,
43  const Flow *f, const uint8_t *data, uint32_t data_len,
44  uint64_t tx_id, uint8_t flags);
45 
46 int OutputRegisterStreamingLogger(LoggerId id, const char *name,
48  ThreadInitFunc ThreadInit, ThreadDeinitFunc ThreadDeinit,
49  ThreadExitPrintStatsFunc ThreadExitPrintStats);
50 
52 
53 void OutputStreamingShutdown(void);
54 
55 #endif /* __OUTPUT_STREAMING_H__ */
OutputStreamingLoggerRegister
void OutputStreamingLoggerRegister(void)
Definition: output-streaming.c:457
Flow_
Flow data structure.
Definition: flow.h:353
StreamingLogger
int(* StreamingLogger)(ThreadVars *, void *thread_data, const Flow *f, const uint8_t *data, uint32_t data_len, uint64_t tx_id, uint8_t flags)
Definition: output-streaming.h:42
LoggerId
LoggerId
Definition: suricata-common.h:437
OutputCtx_
Definition: tm-modules.h:78
OutputRegisterStreamingLogger
int OutputRegisterStreamingLogger(LoggerId id, const char *name, StreamingLogger LogFunc, OutputCtx *, enum OutputStreamingType, ThreadInitFunc ThreadInit, ThreadDeinitFunc ThreadDeinit, ThreadExitPrintStatsFunc ThreadExitPrintStats)
Definition: output-streaming.c:65
ThreadVars_
Per thread variable structure.
Definition: threadvars.h:56
ThreadInitFunc
TmEcode(* ThreadInitFunc)(ThreadVars *, const void *, void **)
Definition: tm-modules.h:39
StreamLogData::f
Flow * f
Definition: output-streaming.c:253
flags
uint8_t flags
Definition: decode-gre.h:0
STREAMING_HTTP_BODIES
@ STREAMING_HTTP_BODIES
Definition: output-streaming.h:38
ThreadExitPrintStatsFunc
void(* ThreadExitPrintStatsFunc)(ThreadVars *, void *)
Definition: tm-modules.h:41
OutputStreamingType
OutputStreamingType
Definition: output-streaming.h:36
STREAMING_TCP_DATA
@ STREAMING_TCP_DATA
Definition: output-streaming.h:37
OutputStreamingShutdown
void OutputStreamingShutdown(void)
Definition: output-streaming.c:463
ThreadDeinitFunc
TmEcode(* ThreadDeinitFunc)(ThreadVars *, void *)
Definition: tm-modules.h:40