| Current File : //usr/share/doc/dbus/api/dbus-server_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>D-Bus: dbus-server.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">D-Bus
 <span id="projectnumber">1.8.20</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>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="headertitle">
<div class="title">dbus-server.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */</span>
<a name="l00002"></a>00002 <span class="comment">/* dbus-server.h DBusServer object</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * Copyright (C) 2002, 2003 Red Hat Inc.</span>
<a name="l00005"></a>00005 <span class="comment"> *</span>
<a name="l00006"></a>00006 <span class="comment"> * Licensed under the Academic Free License version 2.1</span>
<a name="l00007"></a>00007 <span class="comment"> * </span>
<a name="l00008"></a>00008 <span class="comment"> * This program is free software; you can redistribute it and/or modify</span>
<a name="l00009"></a>00009 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00010"></a>00010 <span class="comment"> * the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00011"></a>00011 <span class="comment"> * (at your option) any later version.</span>
<a name="l00012"></a>00012 <span class="comment"> *</span>
<a name="l00013"></a>00013 <span class="comment"> * This program is distributed in the hope that it will be useful,</span>
<a name="l00014"></a>00014 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00015"></a>00015 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00016"></a>00016 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00017"></a>00017 <span class="comment"> * </span>
<a name="l00018"></a>00018 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00019"></a>00019 <span class="comment"> * along with this program; if not, write to the Free Software</span>
<a name="l00020"></a>00020 <span class="comment"> * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA</span>
<a name="l00021"></a>00021 <span class="comment"> *</span>
<a name="l00022"></a>00022 <span class="comment"> */</span>
<a name="l00023"></a>00023 <span class="preprocessor">#if !defined (DBUS_INSIDE_DBUS_H) && !defined (DBUS_COMPILATION)</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#error "Only <dbus/dbus.h> can be included directly, this file may disappear or change contents."</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00026"></a>00026 <span class="preprocessor"></span>
<a name="l00027"></a>00027 <span class="preprocessor">#ifndef DBUS_SERVER_H</span>
<a name="l00028"></a>00028 <span class="preprocessor"></span><span class="preprocessor">#define DBUS_SERVER_H</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include <dbus/dbus-errors.h></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include <dbus/dbus-message.h></span>
<a name="l00032"></a>00032 <span class="preprocessor">#include <dbus/dbus-connection.h></span>
<a name="l00033"></a>00033 <span class="preprocessor">#include <dbus/dbus-protocol.h></span>
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <a class="code" href="group__DBusMacros.html#ga875146b01015e9ced22b25d76d549ab2" title="Macro used prior to declaring functions in the D-Bus header files.">DBUS_BEGIN_DECLS</a>
<a name="l00036"></a>00036
<a name="l00042"></a><a class="code" href="group__DBusServer.html#ga39dc10dc2cbe727cf312c51b25b4341e">00042</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structDBusServer.html" title="Internals of DBusServer object.">DBusServer</a> <a class="code" href="structDBusServer.html" title="Internals of DBusServer object.">DBusServer</a>;
<a name="l00043"></a>00043
<a name="l00047"></a><a class="code" href="group__DBusServer.html#ga8478cd198973f6a6cb224ec23175faa7">00047</a> <span class="keyword">typedef</span> void (* <a class="code" href="group__DBusServer.html#ga8478cd198973f6a6cb224ec23175faa7" title="Called when a new connection to the server is available.">DBusNewConnectionFunction</a>) (<a class="code" href="structDBusServer.html" title="Internals of DBusServer object.">DBusServer</a> *server,
<a name="l00048"></a>00048 <a class="code" href="structDBusConnection.html" title="Implementation details of DBusConnection.">DBusConnection</a> *new_connection,
<a name="l00049"></a>00049 <span class="keywordtype">void</span> *data);
<a name="l00050"></a>00050
<a name="l00051"></a>00051 DBUS_EXPORT
<a name="l00052"></a>00052 <a class="code" href="structDBusServer.html" title="Internals of DBusServer object.">DBusServer</a>* <a class="code" href="group__DBusServer.html#ga4c83cf9f2c186afa97decdc25ac163d8" title="Listens for new connections on the given address.">dbus_server_listen</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="structDBusServer.html#a359852bf33b3051180a9477da4d89acd" title="Address this server is listening on.">address</a>,
<a name="l00053"></a>00053 <a class="code" href="structDBusError.html" title="Object representing an exception.">DBusError</a> *error);
<a name="l00054"></a>00054 DBUS_EXPORT
<a name="l00055"></a>00055 <a class="code" href="structDBusServer.html" title="Internals of DBusServer object.">DBusServer</a>* <a class="code" href="group__DBusServer.html#gabe1c14264ef6bf3e5fe446ab9bf8b913" title="Increments the reference count of a DBusServer.">dbus_server_ref</a> (<a class="code" href="structDBusServer.html" title="Internals of DBusServer object.">DBusServer</a> *server);
<a name="l00056"></a>00056 DBUS_EXPORT
<a name="l00057"></a>00057 <span class="keywordtype">void</span> <a class="code" href="group__DBusServer.html#ga95d0b6cb9795b4919aa08f667807c555" title="Decrements the reference count of a DBusServer.">dbus_server_unref</a> (<a class="code" href="structDBusServer.html" title="Internals of DBusServer object.">DBusServer</a> *server);
<a name="l00058"></a>00058 DBUS_EXPORT
<a name="l00059"></a>00059 <span class="keywordtype">void</span> <a class="code" href="group__DBusServer.html#ga1ff306fbaaa608306b0619ba5c0029a1" title="Releases the server's address and stops listening for new clients.">dbus_server_disconnect</a> (<a class="code" href="structDBusServer.html" title="Internals of DBusServer object.">DBusServer</a> *server);
<a name="l00060"></a>00060 DBUS_EXPORT
<a name="l00061"></a>00061 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusServer.html#ga93c36d8b42a3f2a4f3706a0c3609b3d1" title="Returns TRUE if the server is still listening for new connections.">dbus_server_get_is_connected</a> (<a class="code" href="structDBusServer.html" title="Internals of DBusServer object.">DBusServer</a> *server);
<a name="l00062"></a>00062 DBUS_EXPORT
<a name="l00063"></a>00063 <span class="keywordtype">char</span>* <a class="code" href="group__DBusServer.html#ga63a133dc2786afed48c87127baa96927" title="Returns the address of the server, as a newly-allocated string which must be freed by the caller...">dbus_server_get_address</a> (<a class="code" href="structDBusServer.html" title="Internals of DBusServer object.">DBusServer</a> *server);
<a name="l00064"></a>00064 DBUS_EXPORT
<a name="l00065"></a>00065 <span class="keywordtype">char</span>* <a class="code" href="group__DBusServer.html#ga3b2920b3c65836113781d9dd00d1e139" title="Returns the unique ID of the server, as a newly-allocated string which must be freed by the caller...">dbus_server_get_id</a> (<a class="code" href="structDBusServer.html" title="Internals of DBusServer object.">DBusServer</a> *server);
<a name="l00066"></a>00066 DBUS_EXPORT
<a name="l00067"></a>00067 <span class="keywordtype">void</span> <a class="code" href="group__DBusServer.html#gaa14d9109e04adccffd9a40460c28c53b" title="Sets a function to be used for handling new connections.">dbus_server_set_new_connection_function</a> (<a class="code" href="structDBusServer.html" title="Internals of DBusServer object.">DBusServer</a> *server,
<a name="l00068"></a>00068 <a class="code" href="group__DBusServer.html#ga8478cd198973f6a6cb224ec23175faa7" title="Called when a new connection to the server is available.">DBusNewConnectionFunction</a> <span class="keyword">function</span>,
<a name="l00069"></a>00069 <span class="keywordtype">void</span> *data,
<a name="l00070"></a>00070 <a class="code" href="group__DBusMemory.html#ga061bcded226d76c7d7de35beaa165cb5" title="The type of a function which frees a block of memory.">DBusFreeFunction</a> free_data_function);
<a name="l00071"></a>00071 DBUS_EXPORT
<a name="l00072"></a>00072 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusServer.html#gaa5723810ea52e9f1815062fd91395892" title="Sets the watch functions for the server.">dbus_server_set_watch_functions</a> (<a class="code" href="structDBusServer.html" title="Internals of DBusServer object.">DBusServer</a> *server,
<a name="l00073"></a>00073 <a class="code" href="group__DBusConnection.html#ga9188ca3fd89c957dc269dbe8601b270e" title="Called when libdbus needs a new watch to be monitored by the main loop.">DBusAddWatchFunction</a> add_function,
<a name="l00074"></a>00074 <a class="code" href="group__DBusConnection.html#gaaab846a872d938b27503129551ea0c62" title="Called when libdbus no longer needs a watch to be monitored by the main loop.">DBusRemoveWatchFunction</a> remove_function,
<a name="l00075"></a>00075 <a class="code" href="group__DBusConnection.html#gace13544ff3075b5fccbce896682ec6ff" title="Called when dbus_watch_get_enabled() may return a different value than it did before.">DBusWatchToggledFunction</a> toggled_function,
<a name="l00076"></a>00076 <span class="keywordtype">void</span> *data,
<a name="l00077"></a>00077 <a class="code" href="group__DBusMemory.html#ga061bcded226d76c7d7de35beaa165cb5" title="The type of a function which frees a block of memory.">DBusFreeFunction</a> free_data_function);
<a name="l00078"></a>00078 DBUS_EXPORT
<a name="l00079"></a>00079 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusServer.html#gacafa42ffc063a7386db40a975c32d530" title="Sets the timeout functions for the server.">dbus_server_set_timeout_functions</a> (<a class="code" href="structDBusServer.html" title="Internals of DBusServer object.">DBusServer</a> *server,
<a name="l00080"></a>00080 <a class="code" href="group__DBusConnection.html#ga01a45587090d82ee97b5042b49037a08" title="Called when libdbus needs a new timeout to be monitored by the main loop.">DBusAddTimeoutFunction</a> add_function,
<a name="l00081"></a>00081 <a class="code" href="group__DBusConnection.html#ga13aae9d5981de45abca0db1717dc7daf" title="Called when libdbus no longer needs a timeout to be monitored by the main loop.">DBusRemoveTimeoutFunction</a> remove_function,
<a name="l00082"></a>00082 <a class="code" href="group__DBusConnection.html#ga62eea9a2032ae15b6738534b93d18e86" title="Called when dbus_timeout_get_enabled() may return a different value than it did before.">DBusTimeoutToggledFunction</a> toggled_function,
<a name="l00083"></a>00083 <span class="keywordtype">void</span> *data,
<a name="l00084"></a>00084 <a class="code" href="group__DBusMemory.html#ga061bcded226d76c7d7de35beaa165cb5" title="The type of a function which frees a block of memory.">DBusFreeFunction</a> free_data_function);
<a name="l00085"></a>00085 DBUS_EXPORT
<a name="l00086"></a>00086 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusServer.html#ga309e5f1510c74c4b221d12d874d53341" title="Sets the authentication mechanisms that this server offers to clients, as a NULL-terminated array of ...">dbus_server_set_auth_mechanisms</a> (<a class="code" href="structDBusServer.html" title="Internals of DBusServer object.">DBusServer</a> *server,
<a name="l00087"></a>00087 <span class="keyword">const</span> <span class="keywordtype">char</span> **mechanisms);
<a name="l00088"></a>00088
<a name="l00089"></a>00089 DBUS_EXPORT
<a name="l00090"></a>00090 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusServer.html#ga05d280cd92ea5bb0d49bbe5b1fb1d5c2" title="Allocates an integer ID to be used for storing application-specific data on any DBusServer.">dbus_server_allocate_data_slot</a> (<a class="code" href="group__DBusTypes.html#gab18afa60e9b17b6e322735bda3d863d8" title="A 32-bit signed integer on all platforms.">dbus_int32_t</a> *slot_p);
<a name="l00091"></a>00091 DBUS_EXPORT
<a name="l00092"></a>00092 <span class="keywordtype">void</span> <a class="code" href="group__DBusServer.html#gac6ebc6105e32ab38ef0ac60dec6d5bc8" title="Deallocates a global ID for server data slots.">dbus_server_free_data_slot</a> (<a class="code" href="group__DBusTypes.html#gab18afa60e9b17b6e322735bda3d863d8" title="A 32-bit signed integer on all platforms.">dbus_int32_t</a> *slot_p);
<a name="l00093"></a>00093 DBUS_EXPORT
<a name="l00094"></a>00094 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> <a class="code" href="group__DBusServer.html#gab9ecb216dc9c40b0c7d370673fb9b269" title="Stores a pointer on a DBusServer, along with an optional function to be used for freeing the data whe...">dbus_server_set_data</a> (<a class="code" href="structDBusServer.html" title="Internals of DBusServer object.">DBusServer</a> *server,
<a name="l00095"></a>00095 <span class="keywordtype">int</span> slot,
<a name="l00096"></a>00096 <span class="keywordtype">void</span> *data,
<a name="l00097"></a>00097 <a class="code" href="group__DBusMemory.html#ga061bcded226d76c7d7de35beaa165cb5" title="The type of a function which frees a block of memory.">DBusFreeFunction</a> free_data_func);
<a name="l00098"></a>00098 DBUS_EXPORT
<a name="l00099"></a>00099 <span class="keywordtype">void</span>* <a class="code" href="group__DBusServer.html#gac2bfa9f2e06c4347fefe537b233660d3" title="Retrieves data previously set with dbus_server_set_data().">dbus_server_get_data</a> (<a class="code" href="structDBusServer.html" title="Internals of DBusServer object.">DBusServer</a> *server,
<a name="l00100"></a>00100 <span class="keywordtype">int</span> slot);
<a name="l00101"></a>00101
<a name="l00104"></a>00104 <a class="code" href="group__DBusMacros.html#gae4a9263a43f8220f6e1c0fd07cf6e59a" title="Macro used after declaring functions in the D-Bus header files.">DBUS_END_DECLS</a>
<a name="l00105"></a>00105
<a name="l00106"></a>00106 <span class="preprocessor">#endif </span><span class="comment">/* DBUS_SERVER_H */</span>
</pre></div></div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Mar 3 2016 17:50:31 for D-Bus 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>