isc_logfile Struct Reference

The isc_logfile structure is initialized as part of an isc_logdestination before calling isc_log_createchannel(). More...

#include <log.h>

Data Fields
FILE *	stream
	Initialized to NULL for ISC_LOG_TOFILE.
const char *	name
	NULL for ISC_LOG_TOFILEDESC.
int	versions
isc_offset_t	maximum_size
	stdio's ftell is standardized to return a long, which may well not be big enough for the largest file supportable by the operating system (though it is _probably_ big enough for the largest log anyone would want). st_size returned by fstat should be typedef'd to a size large enough for the largest possible file on a system.
isc_boolean_t	maximum_reached
	Private.

---

Detailed Description

The isc_logfile structure is initialized as part of an isc_logdestination before calling isc_log_createchannel().

When defining an ISC_LOG_TOFILE channel the name, versions and maximum_size should be set before calling isc_log_createchannel(). To define an ISC_LOG_TOFILEDESC channel set only the stream before the call.

Setting maximum_size to zero implies no maximum.

Definition at line 121 of file log.h.

---

Field Documentation

FILE* isc_logfile::stream

Initialized to NULL for ISC_LOG_TOFILE.

Definition at line 122 of file log.h.

Referenced by channel_fromconf(), dns_test_begin(), isc_log_createchannel(), isc_logconfig_create(), isc_test_begin(), main(), ns_log_setdefaultchannels(), ns_log_setsafechannels(), and setup_logging().

const char* isc_logfile::name

NULL for ISC_LOG_TOFILEDESC.

Definition at line 123 of file log.h.

Referenced by channel_fromconf(), dns_test_begin(), isc_log_createchannel(), isc_logconfig_create(), isc_test_begin(), main(), ns_log_setdefaultchannels(), ns_log_setsafechannels(), and setup_logging().

int isc_logfile::versions

Definition at line 124 of file log.h.

Referenced by channel_fromconf(), dns_test_begin(), isc_log_createchannel(), isc_logconfig_create(), isc_test_begin(), main(), ns_log_setdefaultchannels(), ns_log_setsafechannels(), and setup_logging().

isc_offset_t isc_logfile::maximum_size

stdio's ftell is standardized to return a long, which may well not be big enough for the largest file supportable by the operating system (though it is _probably_ big enough for the largest log anyone would want). st_size returned by fstat should be typedef'd to a size large enough for the largest possible file on a system.

Definition at line 132 of file log.h.

Referenced by channel_fromconf(), dns_test_begin(), isc_log_createchannel(), isc_logconfig_create(), isc_test_begin(), main(), ns_log_setdefaultchannels(), ns_log_setsafechannels(), and setup_logging().

isc_boolean_t isc_logfile::maximum_reached

Private.

Definition at line 133 of file log.h.

---

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

• lib/isc/include/isc/log.h

---