1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3 <title>C-Pluff C API: Logging</title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 <link href="tabs.css" rel="stylesheet" type="text/css">
7 <!-- Generated by Doxygen 1.5.1 -->
10 <li><a href="index.html"><span>Main Page</span></a></li>
11 <li><a href="modules.html"><span>Modules</span></a></li>
12 <li><a href="annotated.html"><span>Data Structures</span></a></li>
13 <li><a href="files.html"><span>Files</span></a></li>
14 <li><a href="pages.html"><span>Related Pages</span></a></li>
18 [<a class="el" href="group__cFuncs.html">Functions</a>]</small>
19 </h1><hr><a name="_details"></a><h2>Detailed Description</h2>
20 These functions can be used to receive and emit log messages related to a particular plug-in context.
22 They can be used by the main program or by a plug-in runtime.
24 <table border="0" cellpadding="0" cellspacing="0">
26 <tr><td colspan="2"><br><h2>Functions</h2></td></tr>
27 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__cEnums.html#gd6a8106d281ffa4b1f43fe8e3effc7da">cp_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cFuncsLogging.html#g5f6962ee1b09d60d9b98d25adfd55cff">cp_register_logger</a> (<a class="el" href="group__cTypedefsOpaque.html#gcb1aa0619dcefa746383c5e0833b62e7">cp_context_t</a> *ctx, <a class="el" href="group__cTypedefsFuncs.html#ga53e481fd552856aff67d8584f7e5614">cp_logger_func_t</a> logger, void *user_data, <a class="el" href="group__cEnums.html#g952725f83949f4eb486c390c4ff72aeb">cp_log_severity_t</a> min_severity)</td></tr>
29 <tr><td class="mdescLeft"> </td><td class="mdescRight">Registers a logger with a plug-in context or updates the settings of a registered logger. <a href="#g5f6962ee1b09d60d9b98d25adfd55cff"></a><br></td></tr>
30 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cFuncsLogging.html#g206e88cf84739ff2a0ee6e6925ca5ed8">cp_unregister_logger</a> (<a class="el" href="group__cTypedefsOpaque.html#gcb1aa0619dcefa746383c5e0833b62e7">cp_context_t</a> *ctx, <a class="el" href="group__cTypedefsFuncs.html#ga53e481fd552856aff67d8584f7e5614">cp_logger_func_t</a> logger)</td></tr>
32 <tr><td class="mdescLeft"> </td><td class="mdescRight">Removes a logger registration. <a href="#g206e88cf84739ff2a0ee6e6925ca5ed8"></a><br></td></tr>
33 <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cFuncsLogging.html#g6227362eb74ed67ad53ec20e40b9b7bf">cp_log</a> (<a class="el" href="group__cTypedefsOpaque.html#gcb1aa0619dcefa746383c5e0833b62e7">cp_context_t</a> *ctx, <a class="el" href="group__cEnums.html#g952725f83949f4eb486c390c4ff72aeb">cp_log_severity_t</a> severity, const char *msg)</td></tr>
35 <tr><td class="mdescLeft"> </td><td class="mdescRight">Emits a new log message. <a href="#g6227362eb74ed67ad53ec20e40b9b7bf"></a><br></td></tr>
36 <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cFuncsLogging.html#g16486c754d76d388e0f4c205668c7187">cp_is_logged</a> (<a class="el" href="group__cTypedefsOpaque.html#gcb1aa0619dcefa746383c5e0833b62e7">cp_context_t</a> *ctx, <a class="el" href="group__cEnums.html#g952725f83949f4eb486c390c4ff72aeb">cp_log_severity_t</a> severity)</td></tr>
38 <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether a message of the specified severity would get logged. <a href="#g16486c754d76d388e0f4c205668c7187"></a><br></td></tr>
40 <hr><h2>Function Documentation</h2>
41 <a class="anchor" name="g5f6962ee1b09d60d9b98d25adfd55cff"></a><!-- doxytag: member="cpluff.h::cp_register_logger" ref="g5f6962ee1b09d60d9b98d25adfd55cff" args="(cp_context_t *ctx, cp_logger_func_t logger, void *user_data, cp_log_severity_t min_severity)" -->
43 <div class="memproto">
44 <table class="memname">
46 <td class="memname"><a class="el" href="group__cEnums.html#gd6a8106d281ffa4b1f43fe8e3effc7da">cp_status_t</a> cp_register_logger </td>
48 <td class="paramtype"><a class="el" href="group__cTypedefsOpaque.html#gcb1aa0619dcefa746383c5e0833b62e7">cp_context_t</a> * </td>
49 <td class="paramname"> <em>ctx</em>, </td>
52 <td class="paramkey"></td>
54 <td class="paramtype"><a class="el" href="group__cTypedefsFuncs.html#ga53e481fd552856aff67d8584f7e5614">cp_logger_func_t</a> </td>
55 <td class="paramname"> <em>logger</em>, </td>
58 <td class="paramkey"></td>
60 <td class="paramtype">void * </td>
61 <td class="paramname"> <em>user_data</em>, </td>
64 <td class="paramkey"></td>
66 <td class="paramtype"><a class="el" href="group__cEnums.html#g952725f83949f4eb486c390c4ff72aeb">cp_log_severity_t</a> </td>
67 <td class="paramname"> <em>min_severity</em></td><td> </td>
72 <td></td><td></td><td width="100%"></td>
79 Registers a logger with a plug-in context or updates the settings of a registered logger.
81 The logger will receive selected log messages. If the specified logger is not yet known, a new logger registration is made, otherwise the settings for the existing logger are updated. The logger can be unregistered using <a class="el" href="group__cFuncsLogging.html#g206e88cf84739ff2a0ee6e6925ca5ed8">cp_unregister_logger</a> and it is automatically unregistered when the registering plug-in is stopped or when the context is destroyed.<p>
82 <dl compact><dt><b>Parameters:</b></dt><dd>
83 <table border="0" cellspacing="2" cellpadding="0">
84 <tr><td valign="top"></td><td valign="top"><em>ctx</em> </td><td>the plug-in context to log </td></tr>
85 <tr><td valign="top"></td><td valign="top"><em>logger</em> </td><td>the logger function to be called </td></tr>
86 <tr><td valign="top"></td><td valign="top"><em>user_data</em> </td><td>the user data pointer passed to the logger </td></tr>
87 <tr><td valign="top"></td><td valign="top"><em>min_severity</em> </td><td>the minimum severity of messages passed to logger </td></tr>
90 <dl class="return" compact><dt><b>Returns:</b></dt><dd><a class="el" href="group__cEnums.html#ggd6a8106d281ffa4b1f43fe8e3effc7da5ffbe0fe80af75e699e4b04909912f7a">CP_OK</a> (zero) on success or <a class="el" href="group__cEnums.html#ggd6a8106d281ffa4b1f43fe8e3effc7dac4e31e28c38ba325fa7169da1a233950">CP_ERR_RESOURCE</a> if insufficient memory </dd></dl>
94 <a class="anchor" name="g206e88cf84739ff2a0ee6e6925ca5ed8"></a><!-- doxytag: member="cpluff.h::cp_unregister_logger" ref="g206e88cf84739ff2a0ee6e6925ca5ed8" args="(cp_context_t *ctx, cp_logger_func_t logger)" -->
96 <div class="memproto">
97 <table class="memname">
99 <td class="memname">void cp_unregister_logger </td>
101 <td class="paramtype"><a class="el" href="group__cTypedefsOpaque.html#gcb1aa0619dcefa746383c5e0833b62e7">cp_context_t</a> * </td>
102 <td class="paramname"> <em>ctx</em>, </td>
105 <td class="paramkey"></td>
107 <td class="paramtype"><a class="el" href="group__cTypedefsFuncs.html#ga53e481fd552856aff67d8584f7e5614">cp_logger_func_t</a> </td>
108 <td class="paramname"> <em>logger</em></td><td> </td>
113 <td></td><td></td><td width="100%"></td>
120 Removes a logger registration.
122 <dl compact><dt><b>Parameters:</b></dt><dd>
123 <table border="0" cellspacing="2" cellpadding="0">
124 <tr><td valign="top"></td><td valign="top"><em>ctx</em> </td><td>the plug-in context </td></tr>
125 <tr><td valign="top"></td><td valign="top"><em>logger</em> </td><td>the logger function to be unregistered </td></tr>
131 <a class="anchor" name="g6227362eb74ed67ad53ec20e40b9b7bf"></a><!-- doxytag: member="cpluff.h::cp_log" ref="g6227362eb74ed67ad53ec20e40b9b7bf" args="(cp_context_t *ctx, cp_log_severity_t severity, const char *msg)" -->
132 <div class="memitem">
133 <div class="memproto">
134 <table class="memname">
136 <td class="memname">void cp_log </td>
138 <td class="paramtype"><a class="el" href="group__cTypedefsOpaque.html#gcb1aa0619dcefa746383c5e0833b62e7">cp_context_t</a> * </td>
139 <td class="paramname"> <em>ctx</em>, </td>
142 <td class="paramkey"></td>
144 <td class="paramtype"><a class="el" href="group__cEnums.html#g952725f83949f4eb486c390c4ff72aeb">cp_log_severity_t</a> </td>
145 <td class="paramname"> <em>severity</em>, </td>
148 <td class="paramkey"></td>
150 <td class="paramtype">const char * </td>
151 <td class="paramname"> <em>msg</em></td><td> </td>
156 <td></td><td></td><td width="100%"></td>
163 Emits a new log message.
165 <dl compact><dt><b>Parameters:</b></dt><dd>
166 <table border="0" cellspacing="2" cellpadding="0">
167 <tr><td valign="top"></td><td valign="top"><em>ctx</em> </td><td>the plug-in context </td></tr>
168 <tr><td valign="top"></td><td valign="top"><em>severity</em> </td><td>the severity of the event </td></tr>
169 <tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>the log message (possibly localized) </td></tr>
175 <a class="anchor" name="g16486c754d76d388e0f4c205668c7187"></a><!-- doxytag: member="cpluff.h::cp_is_logged" ref="g16486c754d76d388e0f4c205668c7187" args="(cp_context_t *ctx, cp_log_severity_t severity)" -->
176 <div class="memitem">
177 <div class="memproto">
178 <table class="memname">
180 <td class="memname">int cp_is_logged </td>
182 <td class="paramtype"><a class="el" href="group__cTypedefsOpaque.html#gcb1aa0619dcefa746383c5e0833b62e7">cp_context_t</a> * </td>
183 <td class="paramname"> <em>ctx</em>, </td>
186 <td class="paramkey"></td>
188 <td class="paramtype"><a class="el" href="group__cEnums.html#g952725f83949f4eb486c390c4ff72aeb">cp_log_severity_t</a> </td>
189 <td class="paramname"> <em>severity</em></td><td> </td>
194 <td></td><td></td><td width="100%"></td>
201 Returns whether a message of the specified severity would get logged.
203 <dl compact><dt><b>Parameters:</b></dt><dd>
204 <table border="0" cellspacing="2" cellpadding="0">
205 <tr><td valign="top"></td><td valign="top"><em>ctx</em> </td><td>the plug-in context </td></tr>
206 <tr><td valign="top"></td><td valign="top"><em>severity</em> </td><td>the target logging severity </td></tr>
209 <dl class="return" compact><dt><b>Returns:</b></dt><dd>whether a message of the specified severity would get logged </dd></dl>
215 <a href="http://www.c-pluff.org/">C-Pluff</a>, a plug-in framework for C<br>
216 Copyright 2007 <a href="http://www.jlehtinen.net/">Johannes Lehtinen</a>
218 <p class="generated-by">
219 Generated on Fri Apr 6 15:40:55 2007 for C-Pluff C API by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1