| Current File : //usr/share/doc/net-snmp/html/factory_8h_source.html |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>net-snmp: factory.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">net-snmp
 <span id="projectnumber">5.4.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="headertitle">
<div class="title">factory.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="preprocessor">#ifndef NETSNMP_FACTORY_H</span>
<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define NETSNMP_FACTORY_H</span>
<a name="l00003"></a>00003 <span class="preprocessor"></span>
<a name="l00004"></a>00004
<a name="l00005"></a>00005 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00006"></a>00006 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00007"></a>00007 <span class="preprocessor">#endif</span>
<a name="l00008"></a>00008 <span class="preprocessor"></span>
<a name="l00009"></a>00009 <span class="keyword">typedef</span> <span class="keywordtype">void</span> * (netsnmp_factory_produce_f)(<span class="keywordtype">void</span>);
<a name="l00010"></a>00010 <span class="keyword">typedef</span> int (netsnmp_factory_produce_noalloc_f)(<span class="keywordtype">void</span> *);
<a name="l00011"></a>00011
<a name="l00012"></a><a class="code" href="structnetsnmp__factory__s.html">00012</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structnetsnmp__factory__s.html">netsnmp_factory_s</a> {
<a name="l00013"></a>00013 <span class="comment">/*</span>
<a name="l00014"></a>00014 <span class="comment"> * a string describing the product the factory creates</span>
<a name="l00015"></a>00015 <span class="comment"> */</span>
<a name="l00016"></a>00016 <span class="keyword">const</span> <span class="keywordtype">char</span> *product;
<a name="l00017"></a>00017
<a name="l00018"></a>00018 <span class="comment">/*</span>
<a name="l00019"></a>00019 <span class="comment"> * a function to create an object in newly allcoated memory</span>
<a name="l00020"></a>00020 <span class="comment"> */</span>
<a name="l00021"></a>00021 netsnmp_factory_produce_f *produce;
<a name="l00022"></a>00022
<a name="l00023"></a>00023 <span class="comment">/*</span>
<a name="l00024"></a>00024 <span class="comment"> * a function to create an object in previously allcoated memory</span>
<a name="l00025"></a>00025 <span class="comment"> */</span>
<a name="l00026"></a>00026 netsnmp_factory_produce_noalloc_f *produce_noalloc;
<a name="l00027"></a>00027
<a name="l00028"></a>00028 } <a class="code" href="structnetsnmp__factory__s.html">netsnmp_factory</a>;
<a name="l00029"></a>00029
<a name="l00030"></a>00030 <span class="comment">/*</span>
<a name="l00031"></a>00031 <span class="comment"> * init factory registry</span>
<a name="l00032"></a>00032 <span class="comment"> */</span>
<a name="l00033"></a>00033 <span class="keywordtype">void</span> netsnmp_factory_init(<span class="keywordtype">void</span>);
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="comment">/*</span>
<a name="l00036"></a>00036 <span class="comment"> * register a factory type</span>
<a name="l00037"></a>00037 <span class="comment"> */</span>
<a name="l00038"></a>00038 <span class="keywordtype">int</span> netsnmp_factory_register(<a class="code" href="structnetsnmp__factory__s.html">netsnmp_factory</a> *f);
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="comment">/*</span>
<a name="l00041"></a>00041 <span class="comment"> * get a factory</span>
<a name="l00042"></a>00042 <span class="comment"> */</span>
<a name="l00043"></a>00043 <a class="code" href="structnetsnmp__factory__s.html">netsnmp_factory</a>* netsnmp_factory_get(<span class="keyword">const</span> <span class="keywordtype">char</span>* product);
<a name="l00044"></a>00044
<a name="l00045"></a>00045 <span class="comment">/*</span>
<a name="l00046"></a>00046 <span class="comment"> * ask a factory to produce an object</span>
<a name="l00047"></a>00047 <span class="comment"> */</span>
<a name="l00048"></a>00048 <span class="keywordtype">void</span> * netsnmp_factory_produce(<span class="keyword">const</span> <span class="keywordtype">char</span>* product);
<a name="l00049"></a>00049
<a name="l00050"></a>00050 <span class="comment">/*</span>
<a name="l00051"></a>00051 <span class="comment"> * ask a factory to produce an object in the provided memory</span>
<a name="l00052"></a>00052 <span class="comment"> */</span>
<a name="l00053"></a>00053 <span class="keywordtype">int</span> netsnmp_factory_produce_noalloc(<span class="keyword">const</span> <span class="keywordtype">char</span> *product, <span class="keywordtype">void</span> *memory);
<a name="l00054"></a>00054
<a name="l00055"></a>00055 <span class="comment">/*</span>
<a name="l00056"></a>00056 <span class="comment"> * factory return codes</span>
<a name="l00057"></a>00057 <span class="comment"> */</span>
<a name="l00058"></a>00058 <span class="keyword">enum</span> {
<a name="l00059"></a>00059 FACTORY_NOERROR = 0,
<a name="l00060"></a>00060 FACTORY_EXISTS,
<a name="l00061"></a>00061 FACTORY_NOTFOUND,
<a name="l00062"></a>00062 FACTORY_NOMEMORY,
<a name="l00063"></a>00063 FACTORY_GENERR,
<a name="l00064"></a>00064 FACTORY_MAXIMUM_ERROR
<a name="l00065"></a>00065 };
<a name="l00066"></a>00066
<a name="l00067"></a>00067 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00068"></a>00068 <span class="preprocessor"></span>}
<a name="l00069"></a>00069 <span class="preprocessor">#endif</span>
<a name="l00070"></a>00070 <span class="preprocessor"></span>
<a name="l00071"></a>00071
<a name="l00072"></a>00072 <span class="preprocessor">#endif </span><span class="comment">/* NETSNMP_FACTORY_H */</span>
</pre></div></div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>
</body>
</html>