IBM Enterprise Console manual Cache File

File Type	Description
Configuration	Defines configuration options for adapters.
Error	Defines error logging and tracing options for the
	adapter.
Format	Defines the format of messages and matches them to
	event classes for the UNIX log file, NetWare log file,
	OS/2, and Windows and Windows NT event log
	adapters.
Installation script	Configures the adapter to start when the operating
	system starts.
Object identifier	Defines object-identifier-to-name mappings for the
	NetView®/6000, OpenView, and SNMP adapters.
Registration	The registration file generated by the installation
	script for NetView/6000 and OpenView.
Rules	Defines rules to the event server; must be part of the
	rule base.

An adapter uses the TIVOLI_COMM_DIR Tivoli Management Framework environment variable, if set, to determine which directory to use for its lock and pipe files. If the variable is not set, /tmp/.tivoli is used instead. For more information about this environment variable, see the Tivoli Management Framework Release Notes.

Cache File

Events are written to the cache file using a “circular” method; when the cache file has reached the size limit set by BufEvtMaxSize, the next new event is written to the beginning of the cache file (thus overwriting the existing data at that location). Subsequent events continue being written in order until the end of the file is reached again, and the process starts over from the beginning of the file. A small header at the beginning of the file tracks where the next new event will be written and where the next old event will be removed.

The format of the cache file is as follows:

Cache File Format:

-----------------

maxsz: XXXXXXXXXX

head : XXXXXXXXXX

tail : XXXXXXXXXX

........................event1 event2

event3 event4 event5.................

.....................................

.....................................

.....................................

The first three lines in the cache file all have a fixed size of 18 bytes and contain the following data:

maxsz The maximum size of the cache file.

head The byte offset from the beginning of the file to the next event to send. A value of zero (0) indicates an empty cache file.

tail The byte offset from the beginning of the file to the first byte of free space in the file.

8IBM Tivoli Enterprise Console: Adapters Guide