RubyGems - glib2 - Versions diffs - 0.90.4-x86-mingw32 → 0.90.5-x86-mingw32 - Mend

glib2 0.90.4-x86-mingw32 → 0.90.5-x86-mingw32

Files changed (567) hide show

data/vendor/local/share/gtk-doc/html/gio/GCredentials.html ADDED Viewed

@@ -0,0 +1,398 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>GCredentials</title>
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="index.html" title="GIO Reference Manual">
+<link rel="up" href="networking.html" title="Lowlevel network support">
+<link rel="prev" href="GUnixFDMessage.html" title="GUnixFDMessage">
+<link rel="next" href="GUnixCredentialsMessage.html" title="GUnixCredentialsMessage">
+<meta name="generator" content="GTK-Doc V1.15.1 (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="GUnixFDMessage.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
+<td><a accesskey="u" href="networking.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">GIO Reference Manual</th>
+<td><a accesskey="n" href="GUnixCredentialsMessage.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
+</tr>
+<tr><td colspan="5" class="shortcuts">
+<a href="#GCredentials.synopsis" class="shortcut">Top</a>
+                   |
+                  <a href="#GCredentials.description" class="shortcut">Description</a>
+                   |
+                  <a href="#GCredentials.object-hierarchy" class="shortcut">Object Hierarchy</a>
+</td></tr>
+</table>
+<div class="refentry">
+<a name="GCredentials"></a><div class="titlepage"></div>
+<div class="refnamediv"><table width="100%"><tr>
+<td valign="top">
+<h2><span class="refentrytitle"><a name="GCredentials.top_of_page"></a>GCredentials</span></h2>
+<p>GCredentials — An object containing credentials</p>
+</td>
+<td valign="top" align="right"></td>
+</tr></table></div>
+<div class="refsynopsisdiv">
+<a name="GCredentials.synopsis"></a><h2>Synopsis</h2>
+<pre class="synopsis">
+#include &lt;gio/gio.h&gt;
+                    <a class="link" href="GCredentials.html#GCredentials-struct" title="GCredentials">GCredentials</a>;
+enum                <a class="link" href="GCredentials.html#GCredentialsType" title="enum GCredentialsType">GCredentialsType</a>;
+<a class="link" href="GCredentials.html" title="GCredentials"><span class="returnvalue">GCredentials</span></a> *      <a class="link" href="GCredentials.html#g-credentials-new" title="g_credentials_new ()">g_credentials_new</a>                   (<em class="parameter"><code><span class="type">void</span></code></em>);
+<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="GCredentials.html#g-credentials-to-string" title="g_credentials_to_string ()">g_credentials_to_string</a>             (<em class="parameter"><code><a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a> *credentials</code></em>);
+<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a>            <a class="link" href="GCredentials.html#g-credentials-get-native" title="g_credentials_get_native ()">g_credentials_get_native</a>            (<em class="parameter"><code><a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a> *credentials</code></em>,
+                                                         <em class="parameter"><code><a class="link" href="GCredentials.html#GCredentialsType" title="enum GCredentialsType"><span class="type">GCredentialsType</span></a> native_type</code></em>);
+<span class="returnvalue">void</span>                <a class="link" href="GCredentials.html#g-credentials-set-native" title="g_credentials_set_native ()">g_credentials_set_native</a>            (<em class="parameter"><code><a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a> *credentials</code></em>,
+                                                         <em class="parameter"><code><a class="link" href="GCredentials.html#GCredentialsType" title="enum GCredentialsType"><span class="type">GCredentialsType</span></a> native_type</code></em>,
+                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> native</code></em>);
+<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GCredentials.html#g-credentials-is-same-user" title="g_credentials_is_same_user ()">g_credentials_is_same_user</a>          (<em class="parameter"><code><a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a> *credentials</code></em>,
+                                                         <em class="parameter"><code><a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a> *other_credentials</code></em>,
+                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
+<span class="returnvalue">uid_t</span>               <a class="link" href="GCredentials.html#g-credentials-get-unix-user" title="g_credentials_get_unix_user ()">g_credentials_get_unix_user</a>         (<em class="parameter"><code><a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a> *credentials</code></em>,
+                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
+<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GCredentials.html#g-credentials-set-unix-user" title="g_credentials_set_unix_user ()">g_credentials_set_unix_user</a>         (<em class="parameter"><code><a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a> *credentials</code></em>,
+                                                         <em class="parameter"><code><span class="type">uid_t</span> uid</code></em>,
+                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
+</pre>
+</div>
+<div class="refsect1">
+<a name="GCredentials.object-hierarchy"></a><h2>Object Hierarchy</h2>
+<pre class="synopsis">
+  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+   +----GCredentials
+</pre>
+</div>
+<div class="refsect1">
+<a name="GCredentials.description"></a><h2>Description</h2>
+<p>
+The <a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a> type is a reference-counted wrapper for native
+credentials. This information is typically used for identifying,
+authenticating and authorizing other processes.
+</p>
+<p>
+Some operating systems supports looking up the credentials of the
+remote peer of a communication endpoint - see e.g.
+<a class="link" href="GSocket.html#g-socket-get-credentials" title="g_socket_get_credentials ()"><code class="function">g_socket_get_credentials()</code></a>.
+</p>
+<p>
+Some operating systems supports securely sending and receiving
+credentials over a Unix Domain Socket, see
+<a class="link" href="GUnixCredentialsMessage.html" title="GUnixCredentialsMessage"><span class="type">GUnixCredentialsMessage</span></a>, <a class="link" href="GUnixConnection.html#g-unix-connection-send-credentials" title="g_unix_connection_send_credentials ()"><code class="function">g_unix_connection_send_credentials()</code></a> and
+<a class="link" href="GUnixConnection.html#g-unix-connection-receive-credentials" title="g_unix_connection_receive_credentials ()"><code class="function">g_unix_connection_receive_credentials()</code></a> for details.
+</p>
+<p>
+On Linux, the native credential type is a <span class="type">struct ucred</span>
+- see the
+<span class="citerefentry"><span class="refentrytitle">unix</span>(7)</span>
+man page for details. This corresponds to
+<a class="link" href="GCredentials.html#G-CREDENTIALS-TYPE-LINUX-UCRED:CAPS"><code class="literal">G_CREDENTIALS_TYPE_LINUX_UCRED</code></a>.
+</p>
+<p>
+On FreeBSD, the native credential type is a <span class="type">struct cmsgcred</span>.
+This corresponds to <a class="link" href="GCredentials.html#G-CREDENTIALS-TYPE-FREEBSD-CMSGCRED:CAPS"><code class="literal">G_CREDENTIALS_TYPE_FREEBSD_CMSGCRED</code></a>.
+</p>
+</div>
+<div class="refsect1">
+<a name="GCredentials.details"></a><h2>Details</h2>
+<div class="refsect2">
+<a name="GCredentials-struct"></a><h3>GCredentials</h3>
+<pre class="programlisting">typedef struct _GCredentials GCredentials;</pre>
+<p>
+The <a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a> structure contains only private data and
+should only be accessed using the provided API.
+</p>
+<p class="since">Since 2.26</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GCredentialsType"></a><h3>enum GCredentialsType</h3>
+<pre class="programlisting">typedef enum
+{
+  G_CREDENTIALS_TYPE_INVALID,
+  G_CREDENTIALS_TYPE_LINUX_UCRED,
+  G_CREDENTIALS_TYPE_FREEBSD_CMSGCRED
+} GCredentialsType;
+</pre>
+<p>
+Enumeration describing different kinds of native credential types.
+</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><a name="G-CREDENTIALS-TYPE-INVALID:CAPS"></a><span class="term"><code class="literal">G_CREDENTIALS_TYPE_INVALID</code></span></p></td>
+<td>Indicates an invalid native credential type.
+</td>
+</tr>
+<tr>
+<td><p><a name="G-CREDENTIALS-TYPE-LINUX-UCRED:CAPS"></a><span class="term"><code class="literal">G_CREDENTIALS_TYPE_LINUX_UCRED</code></span></p></td>
+<td>The native credentials type is a <span class="type">struct ucred</span>.
+</td>
+</tr>
+<tr>
+<td><p><a name="G-CREDENTIALS-TYPE-FREEBSD-CMSGCRED:CAPS"></a><span class="term"><code class="literal">G_CREDENTIALS_TYPE_FREEBSD_CMSGCRED</code></span></p></td>
+<td>The native credentials type is a <span class="type">struct cmsgcred</span>.
+</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 2.26</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="g-credentials-new"></a><h3>g_credentials_new ()</h3>
+<pre class="programlisting"><a class="link" href="GCredentials.html" title="GCredentials"><span class="returnvalue">GCredentials</span></a> *      g_credentials_new                   (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<p>
+Creates a new <a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a> object with credentials matching the
+the current process.
+</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody><tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td> A <a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a>. Free with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>.
+</td>
+</tr></tbody>
+</table></div>
+<p class="since">Since 2.26</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="g-credentials-to-string"></a><h3>g_credentials_to_string ()</h3>
+<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             g_credentials_to_string             (<em class="parameter"><code><a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a> *credentials</code></em>);</pre>
+<p>
+Creates a human-readable textual representation of <em class="parameter"><code>credentials</code></em>
+that can be used in logging and debug messages. The format of the
+returned string may change in future GLib release.
+</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>credentials</code></em> :</span></p></td>
+<td>A <a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a> object.
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td> A string that should be freed with <a href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>.
+</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 2.26</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="g-credentials-get-native"></a><h3>g_credentials_get_native ()</h3>
+<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a>            g_credentials_get_native            (<em class="parameter"><code><a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a> *credentials</code></em>,
+                                                         <em class="parameter"><code><a class="link" href="GCredentials.html#GCredentialsType" title="enum GCredentialsType"><span class="type">GCredentialsType</span></a> native_type</code></em>);</pre>
+<p>
+Gets a pointer to native credentials of type <em class="parameter"><code>native_type</code></em> from
+<em class="parameter"><code>credentials</code></em>.
+</p>
+<p>
+It is a programming error (which will cause an warning to be
+logged) to use this method if there is no <a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a> support for
+the OS or if <em class="parameter"><code>native_type</code></em> isn't supported by the OS.
+</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>credentials</code></em> :</span></p></td>
+<td>A <a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a>.
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>native_type</code></em> :</span></p></td>
+<td>The type of native credentials to get.
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td> The pointer to native credentials or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the
+operation there is no <a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a> support for the OS or if
+<em class="parameter"><code>native_type</code></em> isn't supported by the OS. Do not free the returned
+data, it is owned by <em class="parameter"><code>credentials</code></em>.
+</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 2.26</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="g-credentials-set-native"></a><h3>g_credentials_set_native ()</h3>
+<pre class="programlisting"><span class="returnvalue">void</span>                g_credentials_set_native            (<em class="parameter"><code><a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a> *credentials</code></em>,
+                                                         <em class="parameter"><code><a class="link" href="GCredentials.html#GCredentialsType" title="enum GCredentialsType"><span class="type">GCredentialsType</span></a> native_type</code></em>,
+                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> native</code></em>);</pre>
+<p>
+Copies the native credentials of type <em class="parameter"><code>native_type</code></em> from <em class="parameter"><code>native</code></em>
+into <em class="parameter"><code>credentials</code></em>.
+</p>
+<p>
+It is a programming error (which will cause an warning to be
+logged) to use this method if there is no <a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a> support for
+the OS or if <em class="parameter"><code>native_type</code></em> isn't supported by the OS.
+</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>credentials</code></em> :</span></p></td>
+<td>A <a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a>.
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>native_type</code></em> :</span></p></td>
+<td>The type of native credentials to set.
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>native</code></em> :</span></p></td>
+<td>A pointer to native credentials.
+</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 2.26</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="g-credentials-is-same-user"></a><h3>g_credentials_is_same_user ()</h3>
+<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            g_credentials_is_same_user          (<em class="parameter"><code><a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a> *credentials</code></em>,
+                                                         <em class="parameter"><code><a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a> *other_credentials</code></em>,
+                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
+<p>
+Checks if <em class="parameter"><code>credentials</code></em> and <em class="parameter"><code>other_credentials</code></em> is the same user.
+</p>
+<p>
+This operation can fail if <a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a> is not supported on the
+the OS.
+</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>credentials</code></em> :</span></p></td>
+<td>A <a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a>.
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>other_credentials</code></em> :</span></p></td>
+<td>A <a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a>.
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
+<td>Return location for error or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>credentials</code></em> and <em class="parameter"><code>other_credentials</code></em> has the same
+user, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise or if <em class="parameter"><code>error</code></em> is set.
+</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 2.26</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="g-credentials-get-unix-user"></a><h3>g_credentials_get_unix_user ()</h3>
+<pre class="programlisting"><span class="returnvalue">uid_t</span>               g_credentials_get_unix_user         (<em class="parameter"><code><a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a> *credentials</code></em>,
+                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
+<p>
+Tries to get the UNIX user identifier from <em class="parameter"><code>credentials</code></em>. This
+method is only available on UNIX platforms.
+</p>
+<p>
+This operation can fail if <a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a> is not supported on the
+OS or if the native credentials type does not contain information
+about the UNIX user.
+</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>credentials</code></em> :</span></p></td>
+<td>A <a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a>
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
+<td>Return location for error or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td> The UNIX user identifier or -1 if <em class="parameter"><code>error</code></em> is set.
+</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 2.26</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="g-credentials-set-unix-user"></a><h3>g_credentials_set_unix_user ()</h3>
+<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            g_credentials_set_unix_user         (<em class="parameter"><code><a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a> *credentials</code></em>,
+                                                         <em class="parameter"><code><span class="type">uid_t</span> uid</code></em>,
+                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
+<p>
+Tries to set the UNIX user identifier on <em class="parameter"><code>credentials</code></em>. This method
+is only available on UNIX platforms.
+</p>
+<p>
+This operation can fail if <a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a> is not supported on the
+OS or if the native credentials type does not contain information
+about the UNIX user.
+</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>credentials</code></em> :</span></p></td>
+<td>A <a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a>.
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>uid</code></em> :</span></p></td>
+<td>The UNIX user identifier to set.
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
+<td>Return location for error or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>uid</code></em> was set, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if error is set.
+</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 2.26</p>
+</div>
+</div>
+</div>
+<div class="footer">
+<hr>
+          Generated by GTK-Doc V1.15.1</div>
+</body>
+</html>

data/vendor/local/share/gtk-doc/html/gio/GDBusAuthObserver.html ADDED Viewed

@@ -0,0 +1,254 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>GDBusAuthObserver</title>
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="index.html" title="GIO Reference Manual">
+<link rel="up" href="gdbus-lowlevel.html" title="Lowlevel D-Bus Support">
+<link rel="prev" href="GDBusServer.html" title="GDBusServer">
+<link rel="next" href="gdbus-convenience.html" title="Highlevel D-Bus Support">
+<meta name="generator" content="GTK-Doc V1.15.1 (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="GDBusServer.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
+<td><a accesskey="u" href="gdbus-lowlevel.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">GIO Reference Manual</th>
+<td><a accesskey="n" href="gdbus-convenience.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
+</tr>
+<tr><td colspan="5" class="shortcuts">
+<a href="#GDBusAuthObserver.synopsis" class="shortcut">Top</a>
+                   |
+                  <a href="#GDBusAuthObserver.description" class="shortcut">Description</a>
+                   |
+                  <a href="#GDBusAuthObserver.object-hierarchy" class="shortcut">Object Hierarchy</a>
+                   |
+                  <a href="#GDBusAuthObserver.signals" class="shortcut">Signals</a>
+</td></tr>
+</table>
+<div class="refentry">
+<a name="GDBusAuthObserver"></a><div class="titlepage"></div>
+<div class="refnamediv"><table width="100%"><tr>
+<td valign="top">
+<h2><span class="refentrytitle"><a name="GDBusAuthObserver.top_of_page"></a>GDBusAuthObserver</span></h2>
+<p>GDBusAuthObserver — Object used for authenticating connections</p>
+</td>
+<td valign="top" align="right"></td>
+</tr></table></div>
+<div class="refsynopsisdiv">
+<a name="GDBusAuthObserver.synopsis"></a><h2>Synopsis</h2>
+<pre class="synopsis">
+#include &lt;gio/gio.h&gt;
+                    <a class="link" href="GDBusAuthObserver.html#GDBusAuthObserver-struct" title="GDBusAuthObserver">GDBusAuthObserver</a>;
+<a class="link" href="GDBusAuthObserver.html" title="GDBusAuthObserver"><span class="returnvalue">GDBusAuthObserver</span></a> * <a class="link" href="GDBusAuthObserver.html#g-dbus-auth-observer-new" title="g_dbus_auth_observer_new ()">g_dbus_auth_observer_new</a>            (<em class="parameter"><code><span class="type">void</span></code></em>);
+<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GDBusAuthObserver.html#g-dbus-auth-observer-authorize-authenticated-peer" title="g_dbus_auth_observer_authorize_authenticated_peer ()">g_dbus_auth_observer_authorize_authenticated_peer</a>
+                                                        (<em class="parameter"><code><a class="link" href="GDBusAuthObserver.html" title="GDBusAuthObserver"><span class="type">GDBusAuthObserver</span></a> *observer</code></em>,
+                                                         <em class="parameter"><code><a class="link" href="GIOStream.html" title="GIOStream"><span class="type">GIOStream</span></a> *stream</code></em>,
+                                                         <em class="parameter"><code><a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a> *credentials</code></em>);
+</pre>
+</div>
+<div class="refsect1">
+<a name="GDBusAuthObserver.object-hierarchy"></a><h2>Object Hierarchy</h2>
+<pre class="synopsis">
+  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+   +----GDBusAuthObserver
+</pre>
+</div>
+<div class="refsect1">
+<a name="GDBusAuthObserver.signals"></a><h2>Signals</h2>
+<pre class="synopsis">
+  "<a class="link" href="GDBusAuthObserver.html#GDBusAuthObserver-authorize-authenticated-peer" title='The "authorize-authenticated-peer" signal'>authorize-authenticated-peer</a>"                   : Run Last
+</pre>
+</div>
+<div class="refsect1">
+<a name="GDBusAuthObserver.description"></a><h2>Description</h2>
+<p>
+The <a class="link" href="GDBusAuthObserver.html" title="GDBusAuthObserver"><span class="type">GDBusAuthObserver</span></a> type provides a mechanism for participating
+in how a <a class="link" href="GDBusServer.html" title="GDBusServer"><span class="type">GDBusServer</span></a> (or a <a class="link" href="GDBusConnection.html" title="GDBusConnection"><span class="type">GDBusConnection</span></a>) authenticates remote
+peers. Simply instantiate a <a class="link" href="GDBusAuthObserver.html" title="GDBusAuthObserver"><span class="type">GDBusAuthObserver</span></a> and connect to the
+signals you are interested in. Note that new signals may be added
+in the future
+</p>
+<p>
+For example, if you only want to allow D-Bus connections from
+processes owned by the same uid as the server, you would use a
+signal handler like the following:
+</p>
+<div class="example">
+<a name="auth-observer"></a><p class="title"><b>Example 7. Controlling Authentication</b></p>
+<div class="example-contents">
+  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
+    <tbody>
+      <tr>
+        <td class="listing_lines" align="right"><pre>1
+2
+3
+4
+5
+6
+7
+8
+9
+10
+11
+12
+13
+14
+15
+16
+17
+18
+19
+20</pre></td>
+        <td class="listing_code"><pre class="programlisting"><span class="keyword">static</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean">gboolean</a></span>
+<span class="function">on_authorize_authenticated_peer</span><span class="normal"> </span><span class="symbol">(</span><span class="usertype">GDBusAuthObserver</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">observer</span><span class="symbol">,</span>
+<span class="normal">                                 </span><span class="usertype">GIOStream</span><span class="normal">         </span><span class="symbol">*</span><span class="normal">stream</span><span class="symbol">,</span>
+<span class="normal">                                 </span><span class="usertype">GCredentials</span><span class="normal">      </span><span class="symbol">*</span><span class="normal">credentials</span><span class="symbol">,</span>
+<span class="normal">                                 </span><span class="usertype">gpointer</span><span class="normal">           user_data</span><span class="symbol">)</span>
+<span class="cbracket">{</span>
+<span class="normal">  </span><span class="usertype">gboolean</span><span class="normal"> authorized</span><span class="symbol">;</span>
+<span class="normal">  authorized </span><span class="symbol">=</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS">FALSE</a></span><span class="symbol">;</span>
+<span class="normal">  </span><span class="keyword">if</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">credentials </span><span class="symbol">!=</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">)</span>
+<span class="normal">    </span><span class="cbracket">{</span>
+<span class="normal">      </span><span class="usertype">GCredentials</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">own_credentials</span><span class="symbol">;</span>
+<span class="normal">      own_credentials </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GCredentials.html#g-credentials-new">g_credentials_new</a></span><span class="normal"> </span><span class="symbol">();</span>
+<span class="normal">      </span><span class="keyword">if</span><span class="normal"> </span><span class="symbol">(</span><span class="function"><a href="GCredentials.html#g-credentials-is-same-user">g_credentials_is_same_user</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">credentials</span><span class="symbol">,</span><span class="normal"> own_credentials</span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">))</span>
+<span class="normal">        authorized </span><span class="symbol">=</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS">TRUE</a></span><span class="symbol">;</span>
+<span class="normal">      </span><span class="function"><a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">own_credentials</span><span class="symbol">);</span>
+<span class="normal">    </span><span class="cbracket">}</span>
+<span class="normal">  </span><span class="keyword">return</span><span class="normal"> authorized</span><span class="symbol">;</span>
+<span class="cbracket">}</span></pre></td>
+      </tr>
+    </tbody>
+  </table>
+</div>
+</div>
+<p><br class="example-break">
+</p>
+</div>
+<div class="refsect1">
+<a name="GDBusAuthObserver.details"></a><h2>Details</h2>
+<div class="refsect2">
+<a name="GDBusAuthObserver-struct"></a><h3>GDBusAuthObserver</h3>
+<pre class="programlisting">typedef struct _GDBusAuthObserver GDBusAuthObserver;</pre>
+<p>
+The <a class="link" href="GDBusAuthObserver.html" title="GDBusAuthObserver"><span class="type">GDBusAuthObserver</span></a> structure contains only private data and
+should only be accessed using the provided API.
+</p>
+<p class="since">Since 2.26</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="g-dbus-auth-observer-new"></a><h3>g_dbus_auth_observer_new ()</h3>
+<pre class="programlisting"><a class="link" href="GDBusAuthObserver.html" title="GDBusAuthObserver"><span class="returnvalue">GDBusAuthObserver</span></a> * g_dbus_auth_observer_new            (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<p>
+Creates a new <a class="link" href="GDBusAuthObserver.html" title="GDBusAuthObserver"><span class="type">GDBusAuthObserver</span></a> object.
+</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody><tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td> A <a class="link" href="GDBusAuthObserver.html" title="GDBusAuthObserver"><span class="type">GDBusAuthObserver</span></a>. Free with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>.
+</td>
+</tr></tbody>
+</table></div>
+<p class="since">Since 2.26</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="g-dbus-auth-observer-authorize-authenticated-peer"></a><h3>g_dbus_auth_observer_authorize_authenticated_peer ()</h3>
+<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            g_dbus_auth_observer_authorize_authenticated_peer
+                                                        (<em class="parameter"><code><a class="link" href="GDBusAuthObserver.html" title="GDBusAuthObserver"><span class="type">GDBusAuthObserver</span></a> *observer</code></em>,
+                                                         <em class="parameter"><code><a class="link" href="GIOStream.html" title="GIOStream"><span class="type">GIOStream</span></a> *stream</code></em>,
+                                                         <em class="parameter"><code><a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a> *credentials</code></em>);</pre>
+<p>
+Emits the <a class="link" href="GDBusAuthObserver.html#GDBusAuthObserver-authorize-authenticated-peer" title='The "authorize-authenticated-peer" signal'><span class="type">"authorize-authenticated-peer"</span></a> signal on <em class="parameter"><code>observer</code></em>.
+</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>observer</code></em> :</span></p></td>
+<td>A <a class="link" href="GDBusAuthObserver.html" title="GDBusAuthObserver"><span class="type">GDBusAuthObserver</span></a>.
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
+<td>A <a class="link" href="GIOStream.html" title="GIOStream"><span class="type">GIOStream</span></a> for the <a class="link" href="GDBusConnection.html" title="GDBusConnection"><span class="type">GDBusConnection</span></a>.
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>credentials</code></em> :</span></p></td>
+<td>Credentials received from the peer or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the peer is authorized, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if not.
+</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 2.26</p>
+</div>
+</div>
+<div class="refsect1">
+<a name="GDBusAuthObserver.signal-details"></a><h2>Signal Details</h2>
+<div class="refsect2">
+<a name="GDBusAuthObserver-authorize-authenticated-peer"></a><h3>The <code class="literal">"authorize-authenticated-peer"</code> signal</h3>
+<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            user_function                      (<a class="link" href="GDBusAuthObserver.html" title="GDBusAuthObserver"><span class="type">GDBusAuthObserver</span></a> *observer,
+                                                        <a class="link" href="GIOStream.html" title="GIOStream"><span class="type">GIOStream</span></a>         *stream,
+                                                        <a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a>      *credentials,
+                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>           user_data)        : Run Last</pre>
+<p>
+Emitted to check if a peer that is successfully authenticated
+is authorized.
+</p>
+<div class="variablelist"><table border="0">
+<col align="left" valign="top">
+<tbody>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>observer</code></em> :</span></p></td>
+<td>The <a class="link" href="GDBusAuthObserver.html" title="GDBusAuthObserver"><span class="type">GDBusAuthObserver</span></a> emitting the signal.
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
+<td>A <a class="link" href="GIOStream.html" title="GIOStream"><span class="type">GIOStream</span></a> for the <a class="link" href="GDBusConnection.html" title="GDBusConnection"><span class="type">GDBusConnection</span></a>.
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>credentials</code></em> :</span></p></td>
+<td>Credentials received from the peer or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
+</td>
+</tr>
+<tr>
+<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
+<td>user data set when the signal handler was connected.</td>
+</tr>
+<tr>
+<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
+<td> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the peer is authorized, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if not.
+</td>
+</tr>
+</tbody>
+</table></div>
+<p class="since">Since 2.26</p>
+</div>
+</div>
+</div>
+<div class="footer">
+<hr>
+          Generated by GTK-Doc V1.15.1</div>
+</body>
+</html>