OpenDNSSEC-enforcer  1.3.9
message.h
Go to the documentation of this file.
1 /*
2  * $Id: message.h 875 2009-06-02 15:28:33Z sion $
3  *
4  * Copyright (c) 2008-2009 Nominet UK. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
19  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
21  * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
23  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
25  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  *
27  */
28 
29 #ifndef KSM_MESSAGE_H
30 #define KSM_MESSAGE_H
31 
32 /*+
33  * Filename: message.h
34  *
35  * Description:
36  * Definitions of the message utility functions and data structures.
37 -*/
38 
39 #include <stdarg.h>
40 
41 #include <ksm/system_includes.h>
42 #include <ksm/memory.h>
43 
44 #ifdef __cplusplus
45 extern "C" {
46 #endif
47 
48 typedef void (*MSG_OUTPUT_FUNCTION)(const char* text);
49 
50 typedef struct {
51  int min; /* Base value of the error code range */
52  int max; /* Maximum error code value */
53  const char** message; /* Message text value */
54  MSG_OUTPUT_FUNCTION output; /* Output function for this message block */
56 
57 
58 void MsgInit(void);
59 void MsgDefaultOutput(const char* text);
60 void MsgNoOutput(const char* text);
61 void MsgRegister(int min, int max, const char** message,
62  MSG_OUTPUT_FUNCTION output);
63 int MsgFindCodeBlock(int status);
64 const char* MsgText(int status);
66 void MsgSetOutput(int code, MSG_OUTPUT_FUNCTION output);
67 int MsgLog(int status, ...);
68 int MsgLogAp(int status, va_list ap);
69 void MsgRundown(void);
70 
71 
72 #ifdef __cplusplus
73 }
74 #endif
75 
76 #endif /* KSM_MESSAGE_H */