liblogging: syslogmessage.h File Reference

Main Page | Compound List | File List | Compound Members | File Members | Related Pages

# syslogmessage.h File Reference

The syslog message API. More...

Go to the source code of this file.

## Defines
#define | __LIB3195_SYSLOGMESSAGE_H_INCLUDED__ 1
#define | srSLMGCHECKVALIDOBJECT_API(x) {if((x) == NULL) return SR_RET_NULL_POINTER_PROVIDED; if((x)->OID != OIDsrSLMG) return SR_RET_INVALID_HANDLE;}
#define | srSLMGCHECKVALIDOBJECT(x) {assert((x) != NULL);assert((x)->OID == OIDsrSLMG);}

## Detailed Description

The syslog message API.

This file describes the syslog message object. This object is also part of the liblogging API and as such a upper-layer caller may directly invoke all public methods of this object.

The syslog message object (srSLMGObj) is the container wrapping the actual syslog message. It wraps any message, be it plain RFC 3164, 3195, -sign or whatever is to come. The message object contains properties used by any and all syslog protocols. The idea is to have the message object independent from the transport (which is taken care of by srAPI::h).

Note:
  This object supports 8-bit syslog message. When sending, the object looks at its settings to see how non-US-ASCII messages should be processed. Idially, it uses syslog-international (which, of course, is not available at the time of this writing).

Author:
  Rainer Gerhards <rgerhards@adiscon.com>

Date:
  2003-09-01 coding begun.

Copyright 2003 Rainer Gerhards and Adiscon GmbH. All Rights Reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

* Neither the name of Adiscon GmbH or Rainer Gerhards nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.