suricata
Data Fields
TmModule_ Struct Reference

#include <tm-modules.h>

Data Fields

const char * name
 
TmEcode(* ThreadInit )(ThreadVars *, const void *, void **)
 
void(* ThreadExitPrintStats )(ThreadVars *, void *)
 
TmEcode(* ThreadDeinit )(ThreadVars *, void *)
 
TmEcode(* Func )(ThreadVars *, Packet *, void *)
 
TmEcode(* PktAcqLoop )(ThreadVars *, void *, void *)
 
TmEcode(* PktAcqBreakLoop )(ThreadVars *, void *)
 
bool(* ThreadBusy )(ThreadVars *tv, void *thread_data)
 
TmEcode(* Management )(ThreadVars *, void *)
 
TmEcode(* Init )(void)
 
TmEcode(* DeInit )(void)
 
void(* RegisterTests )(void)
 
uint8_t cap_flags
 
uint8_t flags
 

Detailed Description

Definition at line 43 of file tm-modules.h.

Field Documentation

◆ cap_flags

uint8_t TmModule_::cap_flags

Flags to indicate the capability requirement of the given TmModule

Definition at line 73 of file tm-modules.h.

Referenced by TmModuleBypassedFlowManagerRegister(), TmModuleDecodeAFXDPRegister(), TmModuleDecodeDPDKRegister(), TmModuleDecodeErfDagRegister(), TmModuleReceiveAFXDPRegister(), TmModuleReceiveDPDKRegister(), TmModuleReceiveErfDagRegister(), TmModuleReceiveErfFileRegister(), TmModuleUnixManagerRegister(), and TmSlotSetFuncAppend().

◆ DeInit

TmEcode(* TmModule_::DeInit) (void)

Definition at line 69 of file tm-modules.h.

Referenced by TmModuleRunDeInit().

◆ flags

uint8_t TmModule_::flags

Definition at line 76 of file tm-modules.h.

Referenced by TmModuleBypassedFlowManagerRegister(), TmModuleDecodeAFXDPRegister(), TmModuleDecodeDPDKRegister(), TmModuleDecodeErfDagRegister(), TmModuleDecodeWinDivertRegister(), TmModuleReceiveAFXDPRegister(), TmModuleReceiveDPDKRegister(), TmModuleReceiveErfDagRegister(), TmModuleReceiveErfFileRegister(), TmModuleReceiveWinDivertRegister(), TmModuleUnixManagerRegister(), TmSlotSetFuncAppend(), and TmThreadDisableReceiveThreads().

◆ Func

TmEcode(* TmModule_::Func) (ThreadVars *, Packet *, void *)

the packet processing function

Definition at line 52 of file tm-modules.h.

Referenced by TmModuleDebugList(), TmModuleDecodeAFXDPRegister(), TmModuleDecodeDPDKRegister(), TmModuleDecodeErfDagRegister(), TmModuleReceiveAFXDPRegister(), TmModuleReceiveDPDKRegister(), TmModuleReceiveErfDagRegister(), TmModuleReceiveErfFileRegister(), TmModuleRespondRejectRegister(), and TmSlotSetFuncAppend().

◆ Init

TmEcode(* TmModule_::Init) (void)

global Init/DeInit

Definition at line 68 of file tm-modules.h.

Referenced by TmModuleRunInit().

◆ Management

TmEcode(* TmModule_::Management) (ThreadVars *, void *)

Definition at line 65 of file tm-modules.h.

Referenced by TmModuleBypassedFlowManagerRegister(), TmModuleUnixManagerRegister(), and TmSlotSetFuncAppend().

◆ name

const char* TmModule_::name

Definition at line 44 of file tm-modules.h.

Referenced by TmModuleBypassedFlowManagerRegister(), TmModuleDebugList(), TmModuleDecodeAFPRegister(), TmModuleDecodeAFXDPRegister(), TmModuleDecodeCiCaptureRegister(), TmModuleDecodeDPDKRegister(), TmModuleDecodeErfDagRegister(), TmModuleDecodeErfFileRegister(), TmModuleDecodeIPFWRegister(), TmModuleDecodeNetmapRegister(), TmModuleDecodeNFLOGRegister(), TmModuleDecodeNFQRegister(), TmModuleDecodePcapFileRegister(), TmModuleDecodePcapRegister(), TmModuleDecodeWinDivertRegister(), TmModuleDetectLoaderRegister(), TmModuleFlowManagerRegister(), TmModuleFlowRecyclerRegister(), TmModuleFlowWorkerRegister(), TmModuleGetByName(), TmModuleGetIDForTM(), TmModuleReceiveAFPRegister(), TmModuleReceiveAFXDPRegister(), TmModuleReceiveCiCaptureRegister(), TmModuleReceiveDPDKRegister(), TmModuleReceiveErfDagRegister(), TmModuleReceiveErfFileRegister(), TmModuleReceiveNetmapRegister(), TmModuleReceiveNFLOGRegister(), TmModuleReceivePcapFileRegister(), TmModuleReceivePcapRegister(), TmModuleReceiveWinDivertRegister(), TmModuleRegisterTests(), TmModuleRespondRejectRegister(), TmModuleRunDeInit(), TmModuleRunInit(), TmModuleStatsLoggerRegister(), TmModuleUnixManagerRegister(), TmModuleVerdictIPFWRegister(), TmModuleVerdictNFQRegister(), and TmModuleVerdictWinDivertRegister().

◆ PktAcqBreakLoop

TmEcode(* TmModule_::PktAcqBreakLoop) (ThreadVars *, void *)

terminates the capture loop in PktAcqLoop

Definition at line 57 of file tm-modules.h.

Referenced by TmModuleReceiveErfDagRegister(), TmModuleReceiveErfFileRegister(), and TmSlotSetFuncAppend().

◆ PktAcqLoop

TmEcode(* TmModule_::PktAcqLoop) (ThreadVars *, void *, void *)

Definition at line 54 of file tm-modules.h.

Referenced by TmModuleReceiveErfDagRegister(), TmModuleReceiveErfFileRegister(), and TmSlotSetFuncAppend().

◆ RegisterTests

void(* TmModule_::RegisterTests) (void)

Definition at line 71 of file tm-modules.h.

Referenced by TmModuleRegisterTests().

◆ ThreadBusy

bool(* TmModule_::ThreadBusy) (ThreadVars *tv, void *thread_data)

does a thread still have tasks to complete before it can be killed?

Return values
bool
Parameters
tvthreadvars
thread_datathread module thread data (e.g. FlowWorkerThreadData for FlowWorker)

Definition at line 63 of file tm-modules.h.

◆ ThreadDeinit

TmEcode(* TmModule_::ThreadDeinit) (ThreadVars *, void *)

Definition at line 49 of file tm-modules.h.

Referenced by TmModuleBypassedFlowManagerRegister(), TmModuleDecodeAFXDPRegister(), TmModuleDecodeDPDKRegister(), TmModuleDecodeErfDagRegister(), TmModuleReceiveAFXDPRegister(), TmModuleReceiveDPDKRegister(), TmModuleReceiveErfDagRegister(), TmModuleReceiveErfFileRegister(), TmModuleUnixManagerRegister(), and TmSlotSetFuncAppend().

◆ ThreadExitPrintStats

void(* TmModule_::ThreadExitPrintStats) (ThreadVars *, void *)

Definition at line 48 of file tm-modules.h.

Referenced by TmModuleDecodeAFXDPRegister(), TmModuleDecodeDPDKRegister(), TmModuleDecodeErfDagRegister(), TmModuleReceiveAFXDPRegister(), TmModuleReceiveDPDKRegister(), TmModuleReceiveErfDagRegister(), TmModuleReceiveErfFileRegister(), and TmSlotSetFuncAppend().

◆ ThreadInit

TmEcode(* TmModule_::ThreadInit) (ThreadVars *, const void *, void **)

thread handling

Definition at line 47 of file tm-modules.h.

Referenced by TmModuleBypassedFlowManagerRegister(), TmModuleDecodeAFPRegister(), TmModuleDecodeAFXDPRegister(), TmModuleDecodeCiCaptureRegister(), TmModuleDecodeDPDKRegister(), TmModuleDecodeErfDagRegister(), TmModuleDecodeErfFileRegister(), TmModuleDecodeIPFWRegister(), TmModuleDecodeNetmapRegister(), TmModuleDecodeNFLOGRegister(), TmModuleDecodeNFQRegister(), TmModuleDecodePcapFileRegister(), TmModuleDecodePcapRegister(), TmModuleDecodeWinDivertRegister(), TmModuleDetectLoaderRegister(), TmModuleFlowManagerRegister(), TmModuleFlowRecyclerRegister(), TmModuleFlowWorkerRegister(), TmModuleReceiveAFPRegister(), TmModuleReceiveAFXDPRegister(), TmModuleReceiveCiCaptureRegister(), TmModuleReceiveDPDKRegister(), TmModuleReceiveErfDagRegister(), TmModuleReceiveErfFileRegister(), TmModuleReceiveNetmapRegister(), TmModuleReceiveNFLOGRegister(), TmModuleReceivePcapFileRegister(), TmModuleReceivePcapRegister(), TmModuleReceiveWinDivertRegister(), TmModuleRespondRejectRegister(), TmModuleStatsLoggerRegister(), TmModuleUnixManagerRegister(), TmModuleVerdictIPFWRegister(), TmModuleVerdictNFQRegister(), TmModuleVerdictWinDivertRegister(), and TmSlotSetFuncAppend().

The documentation for this struct was generated from the following file: