PNNL

Abstract

Introduction The system event logger is a standard system server that provides general message logging services to the control system. Like all system servers, the event logger is implemented as a C++ class called LoggerServer, which is derived from the BaseServer class (see cliserv.h and cliserv.cpp). As is standard for system servers, there is also an accompanying client interface class, called LoggerClient, which is derived from the BaseClient class (see cliserv.h and cliserv.cpp). The LoggerClient class provides API functions needed by clients to communicate with the server. The logger server and its client interface rely heavily on the the inter-process communication framework, and message handling mechanisms inherited from their parent classes. For that reason, to achieve a detailed understanding of the event logger, the reader should rst be thoroughly familiar with the BaseServer and BaseClient classes. These are fully described in design document DES-0005, The Client/Server Architecture. In the code, the denition and implementation for the event logger can be found in the le loggerServer.cpp. The client interface library for the server is dened and implemented in loggerClientLib.h and loggerClientLib.cpp. Also, a simple text-based menu client for the server exists, and it is implemented in loggerMenu.cpp. The primary documentation for the event log server source code is the Doxygen-generated HTML documentation associated with each of the above source les. That documentation set is automatically built based on the source code itself. It provides the most detailed, most up-to-date descriptions of the code. The document you are reading now is supplemental, and is intended to provide deeper background for the server `and its client API. If contradictions between this document and the Doxygen-generated documentation are found, the Doxygen- generated documentation should be considered correct.