| Current File : //usr/share/doc/dbus/api/dbus-socket-set_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-socket-set.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-socket-set.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">/*</span>
<a name="l00003"></a>00003 <span class="comment"> * dbus-socket-set.h - used to bolt file descriptors onto a bus</span>
<a name="l00004"></a>00004 <span class="comment"> *</span>
<a name="l00005"></a>00005 <span class="comment"> * Copyright © 2011 Nokia Corporation</span>
<a name="l00006"></a>00006 <span class="comment"> *</span>
<a name="l00007"></a>00007 <span class="comment"> * Licensed under the Academic Free License version 2.1</span>
<a name="l00008"></a>00008 <span class="comment"> *</span>
<a name="l00009"></a>00009 <span class="comment"> * This program is free software; you can redistribute it and/or modify</span>
<a name="l00010"></a>00010 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00011"></a>00011 <span class="comment"> * the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00012"></a>00012 <span class="comment"> * (at your option) any later version.</span>
<a name="l00013"></a>00013 <span class="comment"> *</span>
<a name="l00014"></a>00014 <span class="comment"> * This program is distributed in the hope that it will be useful,</span>
<a name="l00015"></a>00015 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00016"></a>00016 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00017"></a>00017 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00018"></a>00018 <span class="comment"> *</span>
<a name="l00019"></a>00019 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00020"></a>00020 <span class="comment"> * along with this program; if not, write to the Free Software</span>
<a name="l00021"></a>00021 <span class="comment"> * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,</span>
<a name="l00022"></a>00022 <span class="comment"> * MA 02110-1301 USA</span>
<a name="l00023"></a>00023 <span class="comment"> *</span>
<a name="l00024"></a>00024 <span class="comment"> */</span>
<a name="l00025"></a>00025
<a name="l00026"></a>00026 <span class="preprocessor">#ifndef DBUS_SOCKET_SET_H</span>
<a name="l00027"></a>00027 <span class="preprocessor"></span><span class="preprocessor">#define DBUS_SOCKET_SET_H</span>
<a name="l00028"></a>00028 <span class="preprocessor"></span>
<a name="l00029"></a>00029 <span class="preprocessor">#ifndef DOXYGEN_SHOULD_SKIP_THIS</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include <dbus/dbus.h></span>
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="keyword">typedef</span> <span class="keyword">struct </span>{
<a name="l00034"></a>00034 <span class="keywordtype">int</span> fd;
<a name="l00035"></a>00035 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> flags;
<a name="l00036"></a>00036 } DBusSocketEvent;
<a name="l00037"></a>00037
<a name="l00038"></a>00038 <span class="keyword">typedef</span> <span class="keyword">struct </span>DBusSocketSet DBusSocketSet;
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="keyword">typedef</span> <span class="keyword">struct </span>DBusSocketSetClass DBusSocketSetClass;
<a name="l00041"></a>00041 <span class="keyword">struct </span>DBusSocketSetClass {
<a name="l00042"></a>00042 void (*free) (DBusSocketSet *<span class="keyword">self</span>);
<a name="l00043"></a>00043 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> (*add) (DBusSocketSet *<span class="keyword">self</span>,
<a name="l00044"></a>00044 <span class="keywordtype">int</span> fd,
<a name="l00045"></a>00045 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> flags,
<a name="l00046"></a>00046 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> enabled);
<a name="l00047"></a>00047 void (*<span class="keyword">remove</span>) (DBusSocketSet *<span class="keyword">self</span>,
<a name="l00048"></a>00048 <span class="keywordtype">int</span> fd);
<a name="l00049"></a>00049 void (*enable) (DBusSocketSet *<span class="keyword">self</span>,
<a name="l00050"></a>00050 <span class="keywordtype">int</span> fd,
<a name="l00051"></a>00051 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> flags);
<a name="l00052"></a>00052 void (*disable) (DBusSocketSet *<span class="keyword">self</span>,
<a name="l00053"></a>00053 <span class="keywordtype">int</span> fd);
<a name="l00054"></a>00054 int (*poll) (DBusSocketSet *<span class="keyword">self</span>,
<a name="l00055"></a>00055 DBusSocketEvent *revents,
<a name="l00056"></a>00056 <span class="keywordtype">int</span> max_events,
<a name="l00057"></a>00057 <span class="keywordtype">int</span> timeout_ms);
<a name="l00058"></a>00058 };
<a name="l00059"></a>00059
<a name="l00060"></a>00060 <span class="keyword">struct </span>DBusSocketSet {
<a name="l00061"></a>00061 DBusSocketSetClass *cls;
<a name="l00062"></a>00062 };
<a name="l00063"></a>00063
<a name="l00064"></a>00064 DBusSocketSet *_dbus_socket_set_new (<span class="keywordtype">int</span> size_hint);
<a name="l00065"></a>00065
<a name="l00066"></a>00066 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span>
<a name="l00067"></a>00067 _dbus_socket_set_free (DBusSocketSet *<span class="keyword">self</span>)
<a name="l00068"></a>00068 {
<a name="l00069"></a>00069 (<span class="keyword">self</span>->cls->free) (<span class="keyword">self</span>);
<a name="l00070"></a>00070 }
<a name="l00071"></a>00071
<a name="l00072"></a>00072 <span class="keyword">static</span> <span class="keyword">inline</span> <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a>
<a name="l00073"></a>00073 _dbus_socket_set_add (DBusSocketSet *<span class="keyword">self</span>,
<a name="l00074"></a>00074 <span class="keywordtype">int</span> fd,
<a name="l00075"></a>00075 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> flags,
<a name="l00076"></a>00076 <a class="code" href="group__DBusTypes.html#ga39c9cb0f3a2a8ad6f55cc4855d035349" title="A boolean, valid values are TRUE and FALSE.">dbus_bool_t</a> enabled)
<a name="l00077"></a>00077 {
<a name="l00078"></a>00078 <span class="keywordflow">return</span> (self->cls->add) (<span class="keyword">self</span>, fd, flags, enabled);
<a name="l00079"></a>00079 }
<a name="l00080"></a>00080
<a name="l00081"></a>00081 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span>
<a name="l00082"></a>00082 _dbus_socket_set_remove (DBusSocketSet *<span class="keyword">self</span>,
<a name="l00083"></a>00083 <span class="keywordtype">int</span> fd)
<a name="l00084"></a>00084 {
<a name="l00085"></a>00085 (<span class="keyword">self</span>->cls->remove) (<span class="keyword">self</span>, fd);
<a name="l00086"></a>00086 }
<a name="l00087"></a>00087
<a name="l00088"></a>00088 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span>
<a name="l00089"></a>00089 _dbus_socket_set_enable (DBusSocketSet *<span class="keyword">self</span>,
<a name="l00090"></a>00090 <span class="keywordtype">int</span> fd,
<a name="l00091"></a>00091 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> flags)
<a name="l00092"></a>00092 {
<a name="l00093"></a>00093 (<span class="keyword">self</span>->cls->enable) (<span class="keyword">self</span>, fd, flags);
<a name="l00094"></a>00094 }
<a name="l00095"></a>00095
<a name="l00096"></a>00096 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">void</span>
<a name="l00097"></a>00097 _dbus_socket_set_disable (DBusSocketSet *<span class="keyword">self</span>,
<a name="l00098"></a>00098 <span class="keywordtype">int</span> fd)
<a name="l00099"></a>00099 {
<a name="l00100"></a>00100 (<span class="keyword">self</span>->cls->disable) (<span class="keyword">self</span>, fd);
<a name="l00101"></a>00101 }
<a name="l00102"></a>00102
<a name="l00103"></a>00103
<a name="l00104"></a>00104 <span class="keyword">static</span> <span class="keyword">inline</span> <span class="keywordtype">int</span>
<a name="l00105"></a>00105 _dbus_socket_set_poll (DBusSocketSet *<span class="keyword">self</span>,
<a name="l00106"></a>00106 DBusSocketEvent *revents,
<a name="l00107"></a>00107 <span class="keywordtype">int</span> max_events,
<a name="l00108"></a>00108 <span class="keywordtype">int</span> timeout_ms)
<a name="l00109"></a>00109 {
<a name="l00110"></a>00110 <span class="keywordflow">return</span> (self->cls->poll) (<span class="keyword">self</span>, revents, max_events, timeout_ms);
<a name="l00111"></a>00111 }
<a name="l00112"></a>00112
<a name="l00113"></a>00113 <span class="comment">/* concrete implementations, not necessarily built on all platforms */</span>
<a name="l00114"></a>00114
<a name="l00115"></a>00115 <span class="keyword">extern</span> DBusSocketSetClass _dbus_socket_set_poll_class;
<a name="l00116"></a>00116 <span class="keyword">extern</span> DBusSocketSetClass _dbus_socket_set_epoll_class;
<a name="l00117"></a>00117
<a name="l00118"></a>00118 DBusSocketSet *_dbus_socket_set_poll_new (<span class="keywordtype">int</span> size_hint);
<a name="l00119"></a>00119 DBusSocketSet *_dbus_socket_set_epoll_new (<span class="keywordtype">void</span>);
<a name="l00120"></a>00120
<a name="l00121"></a>00121 <span class="preprocessor">#endif </span><span class="comment">/* !DOXYGEN_SHOULD_SKIP_THIS */</span>
<a name="l00122"></a>00122 <span class="preprocessor">#endif </span><span class="comment">/* multiple-inclusion guard */</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>