blob: 856064d35a1d28103590ce4fdecf40692dbbd6a4 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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"/>
<meta name="generator" content="Doxygen 1.8.18"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Celix: libs/framework/include/celix_framework.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Celix
&#160;<span id="projectnumber">2.2.1</span>
</div>
<div id="projectbrief">An implementation of the OSGi specification adapted to C and C++</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.18 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_6719ab1f1f7655efc2fa43f7eb574fd1.html">libs</a></li><li class="navelem"><a class="el" href="dir_edbb2ffdc3e165978e68de3a46f2e8a0.html">framework</a></li><li class="navelem"><a class="el" href="dir_bc286dd6b945a73064974dfd7e40f558.html">include</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">celix_framework.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;celix_types.h&quot;</code><br />
<code>#include &quot;celix_properties.h&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for celix_framework.h:</div>
<div class="dyncontent">
<div class="center"><img src="celix__framework_8h__incl.png" border="0" usemap="#libs_2framework_2include_2celix__framework_8h" alt=""/></div>
<map name="libs_2framework_2include_2celix__framework_8h" id="libs_2framework_2include_2celix__framework_8h">
<area shape="rect" title=" " alt="" coords="47,5,198,47"/>
<area shape="rect" title=" " alt="" coords="5,95,104,121"/>
<area shape="rect" title=" " alt="" coords="129,95,253,121"/>
</map>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="celix__framework_8h__dep__incl.png" border="0" usemap="#libs_2framework_2include_2celix__framework_8hdep" alt=""/></div>
<map name="libs_2framework_2include_2celix__framework_8hdep" id="libs_2framework_2include_2celix__framework_8hdep">
<area shape="rect" title=" " alt="" coords="5,5,156,47"/>
<area shape="rect" href="celix__api_8h.html" title=" " alt="" coords="5,95,156,136"/>
</map>
</div>
</div>
<p><a href="celix__framework_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a671ba53e13abea3d4eb328a66b62802f"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="celix__framework_8h.html#a671ba53e13abea3d4eb328a66b62802f">celix_framework_getUUID</a> (const celix_framework_t *fw)</td></tr>
<tr class="separator:a671ba53e13abea3d4eb328a66b62802f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa2e913753f841b3b0b22c196b39d03b1"><td class="memItemLeft" align="right" valign="top">celix_bundle_context_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="celix__framework_8h.html#aa2e913753f841b3b0b22c196b39d03b1">celix_framework_getFrameworkContext</a> (const celix_framework_t *fw)</td></tr>
<tr class="separator:aa2e913753f841b3b0b22c196b39d03b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae980ec9c8f83f8a3e65dc7da9d794f18"><td class="memItemLeft" align="right" valign="top">celix_bundle_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="celix__framework_8h.html#ae980ec9c8f83f8a3e65dc7da9d794f18">celix_framework_getFrameworkBundle</a> (const celix_framework_t *fw)</td></tr>
<tr class="separator:ae980ec9c8f83f8a3e65dc7da9d794f18"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a192ba45dd2a7175fd4d19c70da59f9ab"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="celix__framework_8h.html#a192ba45dd2a7175fd4d19c70da59f9ab">celix_framework_useBundles</a> (celix_framework_t *fw, bool includeFrameworkBundle, void *callbackHandle, void(*use)(void *handle, const celix_bundle_t *bnd))</td></tr>
<tr class="separator:a192ba45dd2a7175fd4d19c70da59f9ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab158bb807ea2171c5d20076cb457c8d1"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="celix__framework_8h.html#ab158bb807ea2171c5d20076cb457c8d1">celix_framework_useBundle</a> (celix_framework_t *fw, bool onlyActive, long bndId, void *callbackHandle, void(*use)(void *handle, const celix_bundle_t *bnd))</td></tr>
<tr class="separator:ab158bb807ea2171c5d20076cb457c8d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ae980ec9c8f83f8a3e65dc7da9d794f18"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae980ec9c8f83f8a3e65dc7da9d794f18">&#9670;&nbsp;</a></span>celix_framework_getFrameworkBundle()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">celix_bundle_t* celix_framework_getFrameworkBundle </td>
<td>(</td>
<td class="paramtype">const celix_framework_t *&#160;</td>
<td class="paramname"><em>fw</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the framework bundle. This is the same as a 'normal' bundle, expect that this bundle cannot be uninstalled and the <code>celix_bundle_getEntry</code> return a entries relative from the working directory. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fw</td><td>The framework </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the bundle of the framework or NULL if something went wrong. </dd></dl>
</div>
</div>
<a id="aa2e913753f841b3b0b22c196b39d03b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa2e913753f841b3b0b22c196b39d03b1">&#9670;&nbsp;</a></span>celix_framework_getFrameworkContext()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">celix_bundle_context_t* celix_framework_getFrameworkContext </td>
<td>(</td>
<td class="paramtype">const celix_framework_t *&#160;</td>
<td class="paramname"><em>fw</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the framework bundle context. This is the same as a 'normal' bundle context and can be used to register, use and track services. The only difference is that the framework is the bundle. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fw</td><td>The framework </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A pointer to the bundle context of the framework or NULL if something went wrong. </dd></dl>
</div>
</div>
<a id="a671ba53e13abea3d4eb328a66b62802f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a671ba53e13abea3d4eb328a66b62802f">&#9670;&nbsp;</a></span>celix_framework_getUUID()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* celix_framework_getUUID </td>
<td>(</td>
<td class="paramtype">const celix_framework_t *&#160;</td>
<td class="paramname"><em>fw</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the framework UUID. This is unique for every created framework and will not be the same if the process is restarted. </p>
</div>
</div>
<a id="ab158bb807ea2171c5d20076cb457c8d1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab158bb807ea2171c5d20076cb457c8d1">&#9670;&nbsp;</a></span>celix_framework_useBundle()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool celix_framework_useBundle </td>
<td>(</td>
<td class="paramtype">celix_framework_t *&#160;</td>
<td class="paramname"><em>fw</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>onlyActive</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long&#160;</td>
<td class="paramname"><em>bndId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>callbackHandle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void(*)(void *handle, const celix_bundle_t *bnd)&#160;</td>
<td class="paramname"><em>use</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Use the bundle with the provided bundle id The provided callback will be called if the bundle is found.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fw</td><td>The framework. </td></tr>
<tr><td class="paramname">onlyActive</td><td>If true only starting and active bundles will trigger the callback. </td></tr>
<tr><td class="paramname">bundleId</td><td>The bundle id. </td></tr>
<tr><td class="paramname">callbackHandle</td><td>The data pointer, which will be used in the callbacks </td></tr>
<tr><td class="paramname">use</td><td>The callback which will be called for the currently started bundles. The bundle pointers are only guaranteed to be valid during the callback. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns true if the bundle is found and the callback is called. </dd></dl>
</div>
</div>
<a id="a192ba45dd2a7175fd4d19c70da59f9ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a192ba45dd2a7175fd4d19c70da59f9ab">&#9670;&nbsp;</a></span>celix_framework_useBundles()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void celix_framework_useBundles </td>
<td>(</td>
<td class="paramtype">celix_framework_t *&#160;</td>
<td class="paramname"><em>fw</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>includeFrameworkBundle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>callbackHandle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void(*)(void *handle, const celix_bundle_t *bnd)&#160;</td>
<td class="paramname"><em>use</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Use the currently active (started) bundles. The provided callback will be called for all the currently started bundles.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ctx</td><td>The bundle context. </td></tr>
<tr><td class="paramname">includeFrameworkBundle</td><td>If true the callback will also be triggered for the framework bundle. </td></tr>
<tr><td class="paramname">callbackHandle</td><td>The data pointer, which will be used in the callbacks </td></tr>
<tr><td class="paramname">use</td><td>The callback which will be called for the currently started bundles. The bundle pointers are only guaranteed to be valid during the callback. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.18
</small></address>
</body>
</html>