OpenDNSSEC-enforcer 1.3.0
/build/buildd/opendnssec-1.3.0/enforcer/ksm/include/ksm/message.h
Go to the documentation of this file.
00001 /*
00002  * $Id: message.h 5320 2011-07-12 10:42:26Z jakob $
00003  *
00004  * Copyright (c) 2008-2009 Nominet UK. All rights reserved.
00005  *
00006  * Redistribution and use in source and binary forms, with or without
00007  * modification, are permitted provided that the following conditions
00008  * are met:
00009  * 1. Redistributions of source code must retain the above copyright
00010  *    notice, this list of conditions and the following disclaimer.
00011  * 2. Redistributions in binary form must reproduce the above copyright
00012  *    notice, this list of conditions and the following disclaimer in the
00013  *    documentation and/or other materials provided with the distribution.
00014  *
00015  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
00016  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
00017  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00018  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
00019  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00020  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
00021  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00022  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
00023  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
00024  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
00025  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00026  *
00027  */
00028 
00029 #ifndef KSM_MESSAGE_H
00030 #define KSM_MESSAGE_H
00031 
00032 /*+
00033  * Filename: message.h
00034  *
00035  * Description:
00036  *      Definitions of the message utility functions and data structures.
00037 -*/
00038 
00039 #include <stdarg.h>
00040 
00041 #include <ksm/system_includes.h>
00042 #include <ksm/memory.h>
00043 
00044 #ifdef __cplusplus
00045 extern "C" {
00046 #endif
00047 
00048 typedef void (*MSG_OUTPUT_FUNCTION)(const char* text);
00049 
00050 typedef struct {
00051     int     min;                /* Base value of the error code range */
00052     int     max;                /* Maximum error code value */
00053     const char** message;       /* Message text value */
00054     MSG_OUTPUT_FUNCTION output; /* Output function for this message block */
00055 } MSG_CODEBLOCK;
00056 
00057 
00058 void MsgInit(void);
00059 void MsgDefaultOutput(const char* text);
00060 void MsgNoOutput(const char* text);
00061 void MsgRegister(int min, int max, const char** message,
00062     MSG_OUTPUT_FUNCTION output);
00063 int MsgFindCodeBlock(int status);
00064 const char* MsgText(int status);
00065 MSG_OUTPUT_FUNCTION MsgGetOutput(int status);
00066 void MsgSetOutput(int code, MSG_OUTPUT_FUNCTION output);
00067 int MsgLog(int status, ...);
00068 int MsgLogAp(int status, va_list ap);
00069 void MsgRundown(void);
00070 
00071 
00072 #ifdef __cplusplus
00073 }
00074 #endif
00075 
00076 #endif /* KSM_MESSAGE_H */