service/protocol-plugin/lib/cpluff/doc/reference/c-api/group__cEnums.html

   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: Enumerations</title>
   4 <link href="doxygen.css" rel="stylesheet" type="text/css">
   5 <link href="tabs.css" rel="stylesheet" type="text/css">
   6 </head><body>
   7 <!-- Generated by Doxygen 1.5.1 -->
   8 <div class="tabs">
   9   <ul>
  10     <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  11     <li><a href="modules.html"><span>Modules</span></a></li>
  12     <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
  13     <li><a href="files.html"><span>Files</span></a></li>
  14     <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  15   </ul></div>
  16 <h1>Enumerations</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
  17 Constant value enumerations.
  18 <p>
  19
  20 <p>
  21 <table border="0" cellpadding="0" cellspacing="0">
  22 <tr><td></td></tr>
  23 <tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
  24 <tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__cEnums.html#gd6a8106d281ffa4b1f43fe8e3effc7da">cp_status_t</a> { <br>
  25 &nbsp;&nbsp;<a class="el" href="group__cEnums.html#ggd6a8106d281ffa4b1f43fe8e3effc7da5ffbe0fe80af75e699e4b04909912f7a">CP_OK</a> =  0,
  26 <a class="el" href="group__cEnums.html#ggd6a8106d281ffa4b1f43fe8e3effc7dac4e31e28c38ba325fa7169da1a233950">CP_ERR_RESOURCE</a>,
  27 <a class="el" href="group__cEnums.html#ggd6a8106d281ffa4b1f43fe8e3effc7da6418acb9f17c3a00ea350684bff9782e">CP_ERR_UNKNOWN</a>,
  28 <a class="el" href="group__cEnums.html#ggd6a8106d281ffa4b1f43fe8e3effc7da2993572d373d8cc61f9655c10fbeefa5">CP_ERR_IO</a>,
  29 <br>
  30 &nbsp;&nbsp;<a class="el" href="group__cEnums.html#ggd6a8106d281ffa4b1f43fe8e3effc7dadc486f602f89493e882cde6a364de0b7">CP_ERR_MALFORMED</a>,
  31 <a class="el" href="group__cEnums.html#ggd6a8106d281ffa4b1f43fe8e3effc7dab07cfdc96a5dbc3a3e359bae2534c9d2">CP_ERR_CONFLICT</a>,
  32 <a class="el" href="group__cEnums.html#ggd6a8106d281ffa4b1f43fe8e3effc7da068a07ac79fdc33dc0c47d14c37005f6">CP_ERR_DEPENDENCY</a>,
  33 <a class="el" href="group__cEnums.html#ggd6a8106d281ffa4b1f43fe8e3effc7dae9eb8fc6b508a70eae974760d8be07aa">CP_ERR_RUNTIME</a>
  34 <br>
  35  }</td></tr>
  36
  37 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An enumeration of status codes returned by API functions.  <a href="group__cEnums.html#gd6a8106d281ffa4b1f43fe8e3effc7da">More...</a><br></td></tr>
  38 <tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__cEnums.html#gd517a8088e2ed89fda71251d9c7b3252">cp_plugin_state_t</a> { <br>
  39 &nbsp;&nbsp;<a class="el" href="group__cEnums.html#ggd517a8088e2ed89fda71251d9c7b325290eacd4f02fb7d65eaf68f7251a99689">CP_PLUGIN_UNINSTALLED</a>,
  40 <a class="el" href="group__cEnums.html#ggd517a8088e2ed89fda71251d9c7b32521c91e4bef84a1d924456fb268a1d848b">CP_PLUGIN_INSTALLED</a>,
  41 <a class="el" href="group__cEnums.html#ggd517a8088e2ed89fda71251d9c7b325275596c790e344583d117d3c6bb4252bd">CP_PLUGIN_RESOLVED</a>,
  42 <a class="el" href="group__cEnums.html#ggd517a8088e2ed89fda71251d9c7b32522c6ca0c8d90c3acb01e336ce1711540c">CP_PLUGIN_STARTING</a>,
  43 <br>
  44 &nbsp;&nbsp;<a class="el" href="group__cEnums.html#ggd517a8088e2ed89fda71251d9c7b32525aafd09bec81bb2bedfd7bfc8643051c">CP_PLUGIN_STOPPING</a>,
  45 <a class="el" href="group__cEnums.html#ggd517a8088e2ed89fda71251d9c7b3252953ad85aee24006f4a5079bfca73eb9f">CP_PLUGIN_ACTIVE</a>
  46 <br>
  47  }</td></tr>
  48
  49 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An enumeration of possible plug-in states.  <a href="group__cEnums.html#gd517a8088e2ed89fda71251d9c7b3252">More...</a><br></td></tr>
  50 <tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__cEnums.html#g952725f83949f4eb486c390c4ff72aeb">cp_log_severity_t</a> { <a class="el" href="group__cEnums.html#gg952725f83949f4eb486c390c4ff72aeb22e3ccb1789e1f0ea3b35e1682fe8af8">CP_LOG_DEBUG</a>,
  51 <a class="el" href="group__cEnums.html#gg952725f83949f4eb486c390c4ff72aebcdb069d62e546b005ae6a81e6cdb0333">CP_LOG_INFO</a>,
  52 <a class="el" href="group__cEnums.html#gg952725f83949f4eb486c390c4ff72aeb26a8a8c987042689e5018e481d235ee0">CP_LOG_WARNING</a>,
  53 <a class="el" href="group__cEnums.html#gg952725f83949f4eb486c390c4ff72aebd99d2bd1dbae181f9a41e90e6bf8d14e">CP_LOG_ERROR</a>
  54  }</td></tr>
  55
  56 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An enumeration of possible message severities for framework logging.  <a href="group__cEnums.html#g952725f83949f4eb486c390c4ff72aeb">More...</a><br></td></tr>
  57 </table>
  58 <hr><h2>Enumeration Type Documentation</h2>
  59 <a class="anchor" name="gd6a8106d281ffa4b1f43fe8e3effc7da"></a><!-- doxytag: member="cpluff.h::cp_status_t" ref="gd6a8106d281ffa4b1f43fe8e3effc7da" args="" -->
  60 <div class="memitem">
  61 <div class="memproto">
  62       <table class="memname">
  63         <tr>
  64           <td class="memname">enum <a class="el" href="group__cEnums.html#gd6a8106d281ffa4b1f43fe8e3effc7da">cp_status_t</a>          </td>
  65         </tr>
  66       </table>
  67 </div>
  68 <div class="memdoc">
  69
  70 <p>
  71 An enumeration of status codes returned by API functions.
  72 <p>
  73 Most of the interface functions return a status code. The returned status code either indicates successful completion of the operation or some specific kind of error. Some functions do not return a status code because they never fail. <dl compact><dt><b>Enumerator: </b></dt><dd>
  74 <table border="0" cellspacing="2" cellpadding="0">
  75 <tr><td valign="top"><em><a class="anchor" name="ggd6a8106d281ffa4b1f43fe8e3effc7da5ffbe0fe80af75e699e4b04909912f7a"></a><!-- doxytag: member="CP_OK" ref="ggd6a8106d281ffa4b1f43fe8e3effc7da5ffbe0fe80af75e699e4b04909912f7a" args="" -->CP_OK</em>&nbsp;</td><td>
  76 Operation was performed successfully (equals to zero). </td></tr>
  77 <tr><td valign="top"><em><a class="anchor" name="ggd6a8106d281ffa4b1f43fe8e3effc7dac4e31e28c38ba325fa7169da1a233950"></a><!-- doxytag: member="CP_ERR_RESOURCE" ref="ggd6a8106d281ffa4b1f43fe8e3effc7dac4e31e28c38ba325fa7169da1a233950" args="" -->CP_ERR_RESOURCE</em>&nbsp;</td><td>
  78 Not enough memory or other operating system resources available. </td></tr>
  79 <tr><td valign="top"><em><a class="anchor" name="ggd6a8106d281ffa4b1f43fe8e3effc7da6418acb9f17c3a00ea350684bff9782e"></a><!-- doxytag: member="CP_ERR_UNKNOWN" ref="ggd6a8106d281ffa4b1f43fe8e3effc7da6418acb9f17c3a00ea350684bff9782e" args="" -->CP_ERR_UNKNOWN</em>&nbsp;</td><td>
  80 The specified object is unknown to the framework. </td></tr>
  81 <tr><td valign="top"><em><a class="anchor" name="ggd6a8106d281ffa4b1f43fe8e3effc7da2993572d373d8cc61f9655c10fbeefa5"></a><!-- doxytag: member="CP_ERR_IO" ref="ggd6a8106d281ffa4b1f43fe8e3effc7da2993572d373d8cc61f9655c10fbeefa5" args="" -->CP_ERR_IO</em>&nbsp;</td><td>
  82 An I/O error occurred. </td></tr>
  83 <tr><td valign="top"><em><a class="anchor" name="ggd6a8106d281ffa4b1f43fe8e3effc7dadc486f602f89493e882cde6a364de0b7"></a><!-- doxytag: member="CP_ERR_MALFORMED" ref="ggd6a8106d281ffa4b1f43fe8e3effc7dadc486f602f89493e882cde6a364de0b7" args="" -->CP_ERR_MALFORMED</em>&nbsp;</td><td>
  84 Malformed plug-in descriptor was encountered when loading a plug-in. </td></tr>
  85 <tr><td valign="top"><em><a class="anchor" name="ggd6a8106d281ffa4b1f43fe8e3effc7dab07cfdc96a5dbc3a3e359bae2534c9d2"></a><!-- doxytag: member="CP_ERR_CONFLICT" ref="ggd6a8106d281ffa4b1f43fe8e3effc7dab07cfdc96a5dbc3a3e359bae2534c9d2" args="" -->CP_ERR_CONFLICT</em>&nbsp;</td><td>
  86 Plug-in or symbol conflicts with another plug-in or symbol. </td></tr>
  87 <tr><td valign="top"><em><a class="anchor" name="ggd6a8106d281ffa4b1f43fe8e3effc7da068a07ac79fdc33dc0c47d14c37005f6"></a><!-- doxytag: member="CP_ERR_DEPENDENCY" ref="ggd6a8106d281ffa4b1f43fe8e3effc7da068a07ac79fdc33dc0c47d14c37005f6" args="" -->CP_ERR_DEPENDENCY</em>&nbsp;</td><td>
  88 Plug-in dependencies could not be satisfied. </td></tr>
  89 <tr><td valign="top"><em><a class="anchor" name="ggd6a8106d281ffa4b1f43fe8e3effc7dae9eb8fc6b508a70eae974760d8be07aa"></a><!-- doxytag: member="CP_ERR_RUNTIME" ref="ggd6a8106d281ffa4b1f43fe8e3effc7dae9eb8fc6b508a70eae974760d8be07aa" args="" -->CP_ERR_RUNTIME</em>&nbsp;</td><td>
  90 Plug-in runtime signaled an error. </td></tr>
  91 </table>
  92 </dl>
  93
  94 </div>
  95 </div><p>
  96 <a class="anchor" name="gd517a8088e2ed89fda71251d9c7b3252"></a><!-- doxytag: member="cpluff.h::cp_plugin_state_t" ref="gd517a8088e2ed89fda71251d9c7b3252" args="" -->
  97 <div class="memitem">
  98 <div class="memproto">
  99       <table class="memname">
 100         <tr>
 101           <td class="memname">enum <a class="el" href="group__cEnums.html#gd517a8088e2ed89fda71251d9c7b3252">cp_plugin_state_t</a>          </td>
 102         </tr>
 103       </table>
 104 </div>
 105 <div class="memdoc">
 106
 107 <p>
 108 An enumeration of possible plug-in states.
 109 <p>
 110 Plug-in states are controlled by <a class="el" href="group__cFuncsPlugin.html">plug-in management functions</a>. Plug-in states can be observed by <a class="el" href="group__cFuncsPluginInfo.html#ge9930a241e859e9eb07e36981ef7077a">registering</a> a <a class="el" href="group__cTypedefsFuncs.html#g24fde3d7324169d8448700123aa97c7a">plug-in listener function</a> or by calling <a class="el" href="group__cFuncsPluginInfo.html#g926489fc366d412cd272ec4bfefe22e5">cp_get_plugin_state</a>.<p>
 111 <dl class="see" compact><dt><b>See also:</b></dt><dd>cp_plugin_listener_t <p>
 112 <a class="el" href="group__cFuncsPluginInfo.html#g926489fc366d412cd272ec4bfefe22e5">cp_get_plugin_state</a> </dd></dl>
 113 <dl compact><dt><b>Enumerator: </b></dt><dd>
 114 <table border="0" cellspacing="2" cellpadding="0">
 115 <tr><td valign="top"><em><a class="anchor" name="ggd517a8088e2ed89fda71251d9c7b325290eacd4f02fb7d65eaf68f7251a99689"></a><!-- doxytag: member="CP_PLUGIN_UNINSTALLED" ref="ggd517a8088e2ed89fda71251d9c7b325290eacd4f02fb7d65eaf68f7251a99689" args="" -->CP_PLUGIN_UNINSTALLED</em>&nbsp;</td><td>
 116 Plug-in is not installed.
 117 <p>
 118 No plug-in information has been loaded. </td></tr>
 119 <tr><td valign="top"><em><a class="anchor" name="ggd517a8088e2ed89fda71251d9c7b32521c91e4bef84a1d924456fb268a1d848b"></a><!-- doxytag: member="CP_PLUGIN_INSTALLED" ref="ggd517a8088e2ed89fda71251d9c7b32521c91e4bef84a1d924456fb268a1d848b" args="" -->CP_PLUGIN_INSTALLED</em>&nbsp;</td><td>
 120 Plug-in is installed.
 121 <p>
 122 At this stage the plug-in information has been loaded but its dependencies to other plug-ins has not yet been resolved. The plug-in runtime has not been loaded yet. The extension points and extensions provided by the plug-in have been registered. </td></tr>
 123 <tr><td valign="top"><em><a class="anchor" name="ggd517a8088e2ed89fda71251d9c7b325275596c790e344583d117d3c6bb4252bd"></a><!-- doxytag: member="CP_PLUGIN_RESOLVED" ref="ggd517a8088e2ed89fda71251d9c7b325275596c790e344583d117d3c6bb4252bd" args="" -->CP_PLUGIN_RESOLVED</em>&nbsp;</td><td>
 124 Plug-in dependencies have been resolved.
 125 <p>
 126 At this stage it has been verified that the dependencies of the plug-in are satisfied and the plug-in runtime has been loaded but it is not active (it has not been started or it has been stopped). Plug-in is resolved when a dependent plug-in is being resolved or before the plug-in is started. Plug-in is put back to installed stage if its dependencies are being uninstalled. </td></tr>
 127 <tr><td valign="top"><em><a class="anchor" name="ggd517a8088e2ed89fda71251d9c7b32522c6ca0c8d90c3acb01e336ce1711540c"></a><!-- doxytag: member="CP_PLUGIN_STARTING" ref="ggd517a8088e2ed89fda71251d9c7b32522c6ca0c8d90c3acb01e336ce1711540c" args="" -->CP_PLUGIN_STARTING</em>&nbsp;</td><td>
 128 Plug-in is starting.
 129 <p>
 130 The plug-in has been resolved and the start function (if any) of the plug-in runtime is about to be called. A plug-in is started when explicitly requested by the main program or when a dependent plug-in is about to be started or when a dynamic symbol defined by the plug-in is being resolved. This state is omitted and the state changes directly from resolved to active if the plug-in runtime does not define a start function. </td></tr>
 131 <tr><td valign="top"><em><a class="anchor" name="ggd517a8088e2ed89fda71251d9c7b32525aafd09bec81bb2bedfd7bfc8643051c"></a><!-- doxytag: member="CP_PLUGIN_STOPPING" ref="ggd517a8088e2ed89fda71251d9c7b32525aafd09bec81bb2bedfd7bfc8643051c" args="" -->CP_PLUGIN_STOPPING</em>&nbsp;</td><td>
 132 Plug-in is stopping.
 133 <p>
 134 The stop function (if any) of the plug-in runtime is about to be called. A plug-in is stopped if the start function fails or when stopping is explicitly requested by the main program or when its dependencies are being stopped. This state is omitted and the state changes directly from active to resolved if the plug-in runtime does not define a stop function. </td></tr>
 135 <tr><td valign="top"><em><a class="anchor" name="ggd517a8088e2ed89fda71251d9c7b3252953ad85aee24006f4a5079bfca73eb9f"></a><!-- doxytag: member="CP_PLUGIN_ACTIVE" ref="ggd517a8088e2ed89fda71251d9c7b3252953ad85aee24006f4a5079bfca73eb9f" args="" -->CP_PLUGIN_ACTIVE</em>&nbsp;</td><td>
 136 Plug-in has been successfully started and it has not yet been stopped. </td></tr>
 137 </table>
 138 </dl>
 139
 140 </div>
 141 </div><p>
 142 <a class="anchor" name="g952725f83949f4eb486c390c4ff72aeb"></a><!-- doxytag: member="cpluff.h::cp_log_severity_t" ref="g952725f83949f4eb486c390c4ff72aeb" args="" -->
 143 <div class="memitem">
 144 <div class="memproto">
 145       <table class="memname">
 146         <tr>
 147           <td class="memname">enum <a class="el" href="group__cEnums.html#g952725f83949f4eb486c390c4ff72aeb">cp_log_severity_t</a>          </td>
 148         </tr>
 149       </table>
 150 </div>
 151 <div class="memdoc">
 152
 153 <p>
 154 An enumeration of possible message severities for framework logging.
 155 <p>
 156 These constants are used when passing a log message to a <a class="el" href="group__cTypedefsFuncs.html#ga53e481fd552856aff67d8584f7e5614">logger function</a> and when <a class="el" href="group__cFuncsLogging.html#g5f6962ee1b09d60d9b98d25adfd55cff">registering</a> a logger function. <dl compact><dt><b>Enumerator: </b></dt><dd>
 157 <table border="0" cellspacing="2" cellpadding="0">
 158 <tr><td valign="top"><em><a class="anchor" name="gg952725f83949f4eb486c390c4ff72aeb22e3ccb1789e1f0ea3b35e1682fe8af8"></a><!-- doxytag: member="CP_LOG_DEBUG" ref="gg952725f83949f4eb486c390c4ff72aeb22e3ccb1789e1f0ea3b35e1682fe8af8" args="" -->CP_LOG_DEBUG</em>&nbsp;</td><td>
 159 Used for detailed debug messages. </td></tr>
 160 <tr><td valign="top"><em><a class="anchor" name="gg952725f83949f4eb486c390c4ff72aebcdb069d62e546b005ae6a81e6cdb0333"></a><!-- doxytag: member="CP_LOG_INFO" ref="gg952725f83949f4eb486c390c4ff72aebcdb069d62e546b005ae6a81e6cdb0333" args="" -->CP_LOG_INFO</em>&nbsp;</td><td>
 161 Used for informational messages such as plug-in state changes. </td></tr>
 162 <tr><td valign="top"><em><a class="anchor" name="gg952725f83949f4eb486c390c4ff72aeb26a8a8c987042689e5018e481d235ee0"></a><!-- doxytag: member="CP_LOG_WARNING" ref="gg952725f83949f4eb486c390c4ff72aeb26a8a8c987042689e5018e481d235ee0" args="" -->CP_LOG_WARNING</em>&nbsp;</td><td>
 163 Used for messages warning about possible problems. </td></tr>
 164 <tr><td valign="top"><em><a class="anchor" name="gg952725f83949f4eb486c390c4ff72aebd99d2bd1dbae181f9a41e90e6bf8d14e"></a><!-- doxytag: member="CP_LOG_ERROR" ref="gg952725f83949f4eb486c390c4ff72aebd99d2bd1dbae181f9a41e90e6bf8d14e" args="" -->CP_LOG_ERROR</em>&nbsp;</td><td>
 165 Used for messages reporting errors. </td></tr>
 166 </table>
 167 </dl>
 168
 169 </div>
 170 </div><p>
 171 <hr size="1">
 172 <p class="footer">
 173 <a href="http://www.c-pluff.org/">C-Pluff</a>, a plug-in framework for C<br>
 174 Copyright 2007 <a href="http://www.jlehtinen.net/">Johannes Lehtinen</a>
 175 </p>
 176 <p class="generated-by">
 177 Generated on Fri Apr 6 15:40:55 2007 for C-Pluff C API by&nbsp;<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1
 178 </p>
 179 </body>
 180 </html>