output-tx.h File Reference

#include "tm-threads.h"
#include "decode.h"
#include "flow.h"

Include dependency graph for output-tx.h:

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

Go to the source code of this file.

Typedefs
typedef int(*	TxLogger) (ThreadVars *, void *thread_data, const Packet *, Flow *f, void *state, void *tx, uint64_t tx_id)
	Transaction logger function pointer type. More...
typedef bool(*	TxLoggerCondition) (ThreadVars *, const Packet *, void *state, void *tx, uint64_t tx_id)
	Transaction logger condition function pointer type. More...

Functions
int	SCOutputRegisterTxLogger (LoggerId id, const char *name, AppProto alproto, TxLogger LogFunc, void *, int tc_log_progress, int ts_log_progress, TxLoggerCondition LogCondition, ThreadInitFunc, ThreadDeinitFunc)
	Register a transaction logger. More...
void	OutputTxLoggerRegister (void)
void	OutputTxShutdown (void)

Detailed Description

Author

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

AppLayer TX Logger Output registration functions

Definition in file output-tx.h.

Typedef Documentation

TxLogger

typedef int(* TxLogger) (ThreadVars *, void *thread_data, const Packet *, Flow *f, void *state, void *tx, uint64_t tx_id)

Transaction logger function pointer type.

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

TxLoggerCondition

typedef bool(* TxLoggerCondition) (ThreadVars *, const Packet *, void *state, void *tx, uint64_t tx_id)

Transaction logger condition function pointer type.

If a TxLoggerCondition is provided to the registration function, the logger function will only be called if this return true.

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

Function Documentation

OutputTxLoggerRegister()

void OutputTxLoggerRegister

(

void

)

Internal function: private API.

Definition at line 655 of file output-tx.c.

References BUG_ON.

OutputTxShutdown()

void OutputTxShutdown

(

void

)

Internal function: private API.

Definition at line 666 of file output-tx.c.

Referenced by GlobalsDestroy().

Here is the caller graph for this function:

SCOutputRegisterTxLogger()

int SCOutputRegisterTxLogger	(	LoggerId	id,
		const char *	name,
		AppProto	alproto,
		TxLogger	LogFunc,
		void *	,
		int	tc_log_progress,
		int	ts_log_progress,
		TxLoggerCondition	LogCondition,
		ThreadInitFunc	,
		ThreadDeinitFunc
	)

Register a transaction logger.

Parameters

logger_id	An ID used to distinguish this logger from others while profiling. For transaction logging this is only used for some internal state tracking.
name	An informational name for this logger. Used for debugging.
alproto	The application layer protocol this logger is for, for example ALPROTO_DNS.
LogFunc	A pointer to the logging function.
initdata	Initialization data that will be provided to the ThreadInit callback.
tc_log_progress	The to_client progress state required for the log function to be called.
ts_log_progress	The to_server progress state required for the log function to be called.
LogCondition	A pointer to a function that will be called before the log function to test if the log function should be called.
ThreadInitFunc	Callback a thread initialization function, initdata will be provided.
ThreadDeinitFunc	Callback to a thread de-initialization function for cleanup.

Definition at line 65 of file output-tx.c.