/usr/share/gtk-doc/html/libinfinity-0.5/InfCommunicationJoinedGroup.html is in libinfinity-0.5-doc 0.5.5-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfCommunicationJoinedGroup</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="libinfinity-0.5 Reference Manual">
<link rel="up" href="ch06.html" title="Network abstraction">
<link rel="prev" href="InfCommunicationHostedGroup.html" title="InfCommunicationHostedGroup">
<link rel="next" href="InfCommunicationFactory.html" title="InfCommunicationFactory">
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="InfCommunicationHostedGroup.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch06.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libinfinity-0.5 Reference Manual</th>
<td><a accesskey="n" href="InfCommunicationFactory.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#InfCommunicationJoinedGroup.synopsis" class="shortcut">Top</a>
|
<a href="#InfCommunicationJoinedGroup.description" class="shortcut">Description</a>
|
<a href="#InfCommunicationJoinedGroup.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#InfCommunicationJoinedGroup.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="InfCommunicationJoinedGroup"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="InfCommunicationJoinedGroup.top_of_page"></a>InfCommunicationJoinedGroup</span></h2>
<p>InfCommunicationJoinedGroup — Communication group opened by a remote host</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="InfCommunicationJoinedGroup.stability-level"></a><h2>Stability Level</h2>
Unstable, unless otherwise indicated
</div>
<div class="refsynopsisdiv">
<a name="InfCommunicationJoinedGroup.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libinfinity/communication/inf-communication-joined-group.h>
<a class="link" href="InfCommunicationJoinedGroup.html#InfCommunicationJoinedGroup-struct" title="InfCommunicationJoinedGroup">InfCommunicationJoinedGroup</a>;
struct <a class="link" href="InfCommunicationJoinedGroup.html#InfCommunicationJoinedGroupClass" title="struct InfCommunicationJoinedGroupClass">InfCommunicationJoinedGroupClass</a>;
<span class="returnvalue">void</span> <a class="link" href="InfCommunicationJoinedGroup.html#inf-communication-joined-group-remove-member" title="inf_communication_joined_group_remove_member ()">inf_communication_joined_group_remove_member</a>
(<em class="parameter"><code><a class="link" href="InfCommunicationJoinedGroup.html" title="InfCommunicationJoinedGroup"><span class="type">InfCommunicationJoinedGroup</span></a> *grp</code></em>,
<em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection</code></em>);
<a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="returnvalue">InfXmlConnection</span></a> * <a class="link" href="InfCommunicationJoinedGroup.html#inf-communication-joined-group-get-publisher" title="inf_communication_joined_group_get_publisher ()">inf_communication_joined_group_get_publisher</a>
(<em class="parameter"><code><a class="link" href="InfCommunicationJoinedGroup.html" title="InfCommunicationJoinedGroup"><span class="type">InfCommunicationJoinedGroup</span></a> *g</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="InfCommunicationJoinedGroup.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----<a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup">InfCommunicationGroup</a>
+----InfCommunicationJoinedGroup
</pre>
</div>
<div class="refsect1">
<a name="InfCommunicationJoinedGroup.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="InfCommunicationJoinedGroup.html#InfCommunicationJoinedGroup--method" title='The "method" property'>method</a>" <span class="type">gchar</span>* : Read / Write / Construct Only
"<a class="link" href="InfCommunicationJoinedGroup.html#InfCommunicationJoinedGroup--publisher" title='The "publisher" property'>publisher</a>" <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a>* : Read / Write / Construct Only
</pre>
</div>
<div class="refsect1">
<a name="InfCommunicationJoinedGroup.description"></a><h2>Description</h2>
<p>
<a class="link" href="InfCommunicationJoinedGroup.html" title="InfCommunicationJoinedGroup"><span class="type">InfCommunicationJoinedGroup</span></a> represents membership of the local host on a
<a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a> opened on a remote host.
</p>
<p>
There is no API to add a member to a joined group. This is because new
members can only join via the group's publisher. It is the job of the
<a class="link" href="InfCommunicationMethod.html" title="InfCommunicationMethod"><span class="type">InfCommunicationMethod</span></a> to tell the joined group about the new member in
which case, the <a class="link" href="InfCommunicationGroup.html#InfCommunicationGroup-member-added" title='The "member-added" signal'><span class="type">"member-added"</span></a> signal will be
emitted.
</p>
</div>
<div class="refsect1">
<a name="InfCommunicationJoinedGroup.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="InfCommunicationJoinedGroup-struct"></a><h3>InfCommunicationJoinedGroup</h3>
<pre class="programlisting">typedef struct _InfCommunicationJoinedGroup InfCommunicationJoinedGroup;</pre>
<p>
<a class="link" href="InfCommunicationJoinedGroup.html" title="InfCommunicationJoinedGroup"><span class="type">InfCommunicationJoinedGroup</span></a> is an opaque data type. You should only
access it via the public API functions.
</p>
</div>
<hr>
<div class="refsect2">
<a name="InfCommunicationJoinedGroupClass"></a><h3>struct InfCommunicationJoinedGroupClass</h3>
<pre class="programlisting">struct InfCommunicationJoinedGroupClass {
};
</pre>
<p>
This structure does not contain any public fields.
</p>
</div>
<hr>
<div class="refsect2">
<a name="inf-communication-joined-group-remove-member"></a><h3>inf_communication_joined_group_remove_member ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> inf_communication_joined_group_remove_member
(<em class="parameter"><code><a class="link" href="InfCommunicationJoinedGroup.html" title="InfCommunicationJoinedGroup"><span class="type">InfCommunicationJoinedGroup</span></a> *grp</code></em>,
<em class="parameter"><code><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> *connection</code></em>);</pre>
<p>
Removes <em class="parameter"><code>connection</code></em> as <em class="parameter"><code>grp</code></em>'s member. On the remote site, the
corresponding <a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a> needs to be freed (which may be a
<a class="link" href="InfCommunicationJoinedGroup.html" title="InfCommunicationJoinedGroup"><span class="type">InfCommunicationJoinedGroup</span></a> or a <a class="link" href="InfCommunicationHostedGroup.html" title="InfCommunicationHostedGroup"><span class="type">InfCommunicationHostedGroup</span></a>).
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>grp</code></em> :</span></p></td>
<td>A <a class="link" href="InfCommunicationJoinedGroup.html" title="InfCommunicationJoinedGroup"><span class="type">InfCommunicationJoinedGroup</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td>
<td>A connection to a member of <em class="parameter"><code>grp</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="inf-communication-joined-group-get-publisher"></a><h3>inf_communication_joined_group_get_publisher ()</h3>
<pre class="programlisting"><a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="returnvalue">InfXmlConnection</span></a> * inf_communication_joined_group_get_publisher
(<em class="parameter"><code><a class="link" href="InfCommunicationJoinedGroup.html" title="InfCommunicationJoinedGroup"><span class="type">InfCommunicationJoinedGroup</span></a> *g</code></em>);</pre>
<p>
Returns a <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a> to the group's publisher, or <code class="literal">NULL</code> if the
publisher is no longer a group member.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>g</code></em> :</span></p></td>
<td>A <a class="link" href="InfCommunicationJoinedGroup.html" title="InfCommunicationJoinedGroup"><span class="type">InfCommunicationJoinedGroup</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a>, or <code class="literal">NULL</code>.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="InfCommunicationJoinedGroup.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="InfCommunicationJoinedGroup--method"></a><h3>The <code class="literal">"method"</code> property</h3>
<pre class="programlisting"> "method" <span class="type">gchar</span>* : Read / Write / Construct Only</pre>
<p>The communication method to use for this group.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="InfCommunicationJoinedGroup--publisher"></a><h3>The <code class="literal">"publisher"</code> property</h3>
<pre class="programlisting"> "publisher" <a class="link" href="InfXmlConnection.html" title="InfXmlConnection"><span class="type">InfXmlConnection</span></a>* : Read / Write / Construct Only</pre>
<p>A connection to the group's publisher.</p>
</div>
</div>
<div class="refsect1">
<a name="InfCommunicationJoinedGroup.see-also"></a><h2>See Also</h2>
<a class="link" href="InfCommunicationGroup.html" title="InfCommunicationGroup"><span class="type">InfCommunicationGroup</span></a>, <a class="link" href="InfCommunicationManager.html" title="InfCommunicationManager"><span class="type">InfCommunicationManager</span></a>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|