output-streaming.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	OUTPUT_STREAMING_FLAG_OPEN   0x01
#define	OUTPUT_STREAMING_FLAG_CLOSE   0x02
#define	OUTPUT_STREAMING_FLAG_TOSERVER   0x04
#define	OUTPUT_STREAMING_FLAG_TOCLIENT   0x08
#define	OUTPUT_STREAMING_FLAG_TRANSACTION   0x10

Typedefs
typedef int(*	SCStreamingLogger) (ThreadVars *, void *thread_data, const Flow *f, const uint8_t *data, uint32_t data_len, uint64_t tx_id, uint8_t flags)

Enumerations
enum	SCOutputStreamingType { STREAMING_TCP_DATA, STREAMING_HTTP_BODIES }

Functions
int	SCOutputRegisterStreamingLogger (LoggerId logger_id, const char *name, SCStreamingLogger LogFunc, void *initdata, enum SCOutputStreamingType stream_type, ThreadInitFunc ThreadInit, ThreadDeinitFunc ThreadDeinit)
	Register a streaming logger. More...
void	OutputStreamingLoggerRegister (void)
void	OutputStreamingShutdown (void)

Detailed Description

Author

Victor Julien victo.nosp@m.r@in.nosp@m.linia.nosp@m.c.ne.nosp@m.t

Streaming Logger Output registration functions

Definition in file output-streaming.h.

Macro Definition Documentation

OUTPUT_STREAMING_FLAG_CLOSE

#define OUTPUT_STREAMING_FLAG_CLOSE   0x02

Definition at line 31 of file output-streaming.h.

OUTPUT_STREAMING_FLAG_OPEN

#define OUTPUT_STREAMING_FLAG_OPEN   0x01

Definition at line 30 of file output-streaming.h.

OUTPUT_STREAMING_FLAG_TOCLIENT

#define OUTPUT_STREAMING_FLAG_TOCLIENT   0x08

Definition at line 33 of file output-streaming.h.

OUTPUT_STREAMING_FLAG_TOSERVER

#define OUTPUT_STREAMING_FLAG_TOSERVER   0x04

Definition at line 32 of file output-streaming.h.

OUTPUT_STREAMING_FLAG_TRANSACTION

#define OUTPUT_STREAMING_FLAG_TRANSACTION   0x10

Definition at line 34 of file output-streaming.h.

Typedef Documentation

SCStreamingLogger

typedef int(* SCStreamingLogger) (ThreadVars *, void *thread_data, const Flow *f, const uint8_t *data, uint32_t data_len, uint64_t tx_id, uint8_t flags)

streaming logger function pointer type

Definition at line 41 of file output-streaming.h.

Enumeration Type Documentation

SCOutputStreamingType

enum SCOutputStreamingType

Enumerator
STREAMING_TCP_DATA
STREAMING_HTTP_BODIES

Definition at line 35 of file output-streaming.h.

Function Documentation

OutputStreamingLoggerRegister()

void OutputStreamingLoggerRegister

(

void

)

Internal function: private API.

Definition at line 434 of file output-streaming.c.

References OutputRegisterRootLogger().

Here is the call graph for this function:

OutputStreamingShutdown()

void OutputStreamingShutdown

(

void

)

Internal function: private API.

Definition at line 439 of file output-streaming.c.

SCOutputRegisterStreamingLogger()

int SCOutputRegisterStreamingLogger	(	LoggerId	logger_id,
		const char *	name,
		SCStreamingLogger	LogFunc,
		void *	initdata,
		enum SCOutputStreamingType	stream_type,
		ThreadInitFunc	ThreadInit,
		ThreadDeinitFunc	ThreadDeinit
	)

Register a streaming logger.

Parameters

logger_id	An ID to uniquely identify this logger.
name	An informational name for this logger.
LogFunc	Pointer to logging function.
initdata	Initialization data that will be passed the ThreadInit.
stream_type	Type of stream to log, see SCOutputStreamingType.
ThreadInit	Pointer to thread initialization function.
ThreadDeinit	Pointer to thread de-initialization function.

Definition at line 63 of file output-streaming.c.