#include <util-logopenfile.h>
Data Fields | |
| union { | |
| FILE * fp | |
| }; | |
| LogThreadedFileCtx * | threads |
| union { | |
| }; | |
| int(* | Write )(const char *buffer, int buffer_len, struct LogFileCtx_ *fp) |
| void(* | Close )(struct LogFileCtx_ *fp) |
| void(* | Flush )(struct LogFileCtx_ *fp) |
| void(* | Rotate )(struct LogFileCtx_ *fp) |
| LogFileTypeCtx | filetype |
| SCMutex | fp_mutex |
| bool | threaded |
| struct LogFileCtx_ * | parent |
| ThreadLogFileHashEntry * | entry |
| enum LogFileType | type |
| char * | filename |
| uint32_t | filemode |
| uint32_t | buffer_size |
| char * | sensor_name |
| int | is_sock |
| int | sock_type |
| uint64_t | reconn_timer |
| time_t | rotate_time |
| uint64_t | rotate_interval |
| LogFileRotateUnit | rotate_unit |
| int64_t | rotate_period |
| char * | prefix |
| uint32_t | prefix_len |
| uint64_t | size_limit |
| uint64_t | size_current |
| uint8_t | flags |
| uint8_t | send_flags |
| uint8_t | is_regular |
| bool | compress_ipv6 |
| int | rotation_flag |
| size_t | json_flags |
| bool | is_pcap_offline |
| uint64_t | dropped |
| uint64_t | output_errors |
| uint64_t | bytes_since_last_flush |
Detailed Description
Global structure for Output Context
Definition at line 85 of file util-logopenfile.h.
Field Documentation
◆ @160
| union { ... } |
◆ @162
| union { ... } |
◆ buffer_size
| uint32_t LogFileCtx_::buffer_size |
File buffering
Definition at line 126 of file util-logopenfile.h.
◆ bytes_since_last_flush
| uint64_t LogFileCtx_::bytes_since_last_flush |
Definition at line 187 of file util-logopenfile.h.
Referenced by LogFileFlush().
◆ Close
| void(* LogFileCtx_::Close) (struct LogFileCtx_ *fp) |
Definition at line 101 of file util-logopenfile.h.
Referenced by LogFileFreeCtx().
◆ compress_ipv6
| bool LogFileCtx_::compress_ipv6 |
Definition at line 169 of file util-logopenfile.h.
Referenced by SCConfLogOpenGeneric().
◆ dropped
| uint64_t LogFileCtx_::dropped |
Definition at line 182 of file util-logopenfile.h.
◆ entry
| ThreadLogFileHashEntry* LogFileCtx_::entry |
Definition at line 114 of file util-logopenfile.h.
◆ filemode
| uint32_t LogFileCtx_::filemode |
File permissions
Definition at line 123 of file util-logopenfile.h.
◆ filename
| char* LogFileCtx_::filename |
The name of the file
Definition at line 120 of file util-logopenfile.h.
Referenced by LogFileFlush(), LogFileFreeCtx(), and SCConfLogReopen().
◆ filetype
| LogFileTypeCtx LogFileCtx_::filetype |
Definition at line 105 of file util-logopenfile.h.
Referenced by LogFileFreeCtx(), and LogFileWrite().
◆ flags
| uint8_t LogFileCtx_::flags |
Definition at line 159 of file util-logopenfile.h.
◆ Flush
| void(* LogFileCtx_::Flush) (struct LogFileCtx_ *fp) |
Definition at line 102 of file util-logopenfile.h.
Referenced by LogFileFlush().
◆ fp
| FILE* LogFileCtx_::fp |
Definition at line 87 of file util-logopenfile.h.
Referenced by LogFileFreeCtx(), SCConfLogOpenGeneric(), and SCConfLogReopen().
◆ fp_mutex
| SCMutex LogFileCtx_::fp_mutex |
It will be locked if the log/alert record cannot be written to the file in one call
Definition at line 109 of file util-logopenfile.h.
Referenced by LogFileFreeCtx(), and LogFileWrite().
◆ is_pcap_offline
| bool LogFileCtx_::is_pcap_offline |
Definition at line 178 of file util-logopenfile.h.
Referenced by OutputJSONBuffer(), and OutputJsonBuilderBuffer().
◆ is_regular
| uint8_t LogFileCtx_::is_regular |
Definition at line 166 of file util-logopenfile.h.
Referenced by SCConfLogReopen().
◆ is_sock
| int LogFileCtx_::is_sock |
Handle auto-connecting / reconnecting sockets
Definition at line 132 of file util-logopenfile.h.
◆ json_flags
| size_t LogFileCtx_::json_flags |
Definition at line 175 of file util-logopenfile.h.
Referenced by OutputJSONBuffer().
◆ output_errors
| uint64_t LogFileCtx_::output_errors |
Definition at line 184 of file util-logopenfile.h.
◆ parent
| struct LogFileCtx_* LogFileCtx_::parent |
Definition at line 113 of file util-logopenfile.h.
Referenced by LogFileFreeCtx().
◆ prefix
| char* LogFileCtx_::prefix |
Definition at line 150 of file util-logopenfile.h.
Referenced by LogFileFreeCtx(), and OutputJSONBuffer().
◆ prefix_len
| uint32_t LogFileCtx_::prefix_len |
Definition at line 151 of file util-logopenfile.h.
Referenced by LogFileFreeCtx(), and OutputJSONBuffer().
◆ reconn_timer
| uint64_t LogFileCtx_::reconn_timer |
Definition at line 134 of file util-logopenfile.h.
◆ Rotate
| void(* LogFileCtx_::Rotate) (struct LogFileCtx_ *fp) |
Definition at line 103 of file util-logopenfile.h.
◆ rotate_interval
| uint64_t LogFileCtx_::rotate_interval |
The interval to rotate the log file
Definition at line 142 of file util-logopenfile.h.
Referenced by SCConfLogOpenGeneric().
◆ rotate_period
| int64_t LogFileCtx_::rotate_period |
Local time period of the open file, for calendar units Used by some alert loggers like the unified ones that append the date onto the end of files.
Definition at line 146 of file util-logopenfile.h.
◆ rotate_time
| time_t LogFileCtx_::rotate_time |
The next time to rotate log file, if rotate interval is specified. For calendar units, the next time to check if the local time period changed.
Definition at line 139 of file util-logopenfile.h.
◆ rotate_unit
| LogFileRotateUnit LogFileCtx_::rotate_unit |
Definition at line 144 of file util-logopenfile.h.
Referenced by SCConfLogOpenGeneric().
◆ rotation_flag
| int LogFileCtx_::rotation_flag |
Definition at line 172 of file util-logopenfile.h.
Referenced by LogFileFreeCtx().
◆ send_flags
| uint8_t LogFileCtx_::send_flags |
Definition at line 162 of file util-logopenfile.h.
◆ sensor_name
| char* LogFileCtx_::sensor_name |
Suricata sensor name
Definition at line 129 of file util-logopenfile.h.
Referenced by LogFileFreeCtx(), OutputJSONBuffer(), OutputJsonBuilderBuffer(), and OutputJsonInitCtx().
◆ size_current
| uint64_t LogFileCtx_::size_current |
file current size
Definition at line 156 of file util-logopenfile.h.
◆ size_limit
| uint64_t LogFileCtx_::size_limit |
Generic size_limit and size_current They must be common to the threads accessing the same file file size limit
Definition at line 155 of file util-logopenfile.h.
◆ sock_type
| int LogFileCtx_::sock_type |
Definition at line 133 of file util-logopenfile.h.
◆ threaded
| bool LogFileCtx_::threaded |
When threaded, track of the parent and thread id
Definition at line 112 of file util-logopenfile.h.
Referenced by LogFileEnsureExists(), and LogFileFreeCtx().
◆ threads
| LogThreadedFileCtx* LogFileCtx_::threads |
Definition at line 92 of file util-logopenfile.h.
Referenced by LogFileEnsureExists(), LogFileFreeCtx(), and SCLogOpenThreadedFile().
◆ type
| enum LogFileType LogFileCtx_::type |
the type of file
Definition at line 114 of file util-logopenfile.h.
Referenced by LogFileFreeCtx(), and LogFileWrite().
◆ Write
| int(* LogFileCtx_::Write) (const char *buffer, int buffer_len, struct LogFileCtx_ *fp) |
Definition at line 100 of file util-logopenfile.h.
Referenced by LogFileNewCtx(), and LogFileWrite().
The documentation for this struct was generated from the following file:
