docs/reference/gio/html/GUnixCredentialsMessage.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>GUnixCredentialsMessage</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GIO Reference Manual">
   8 <link rel="up" href="networking.html" title="Low-level network support">
   9 <link rel="prev" href="GCredentials.html" title="GCredentials">
  10 <link rel="next" href="GProxy.html" title="GProxy">
  11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="GCredentials.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="networking.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GIO Reference Manual</th>
  21 <td><a accesskey="n" href="GProxy.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#GUnixCredentialsMessage.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#GUnixCredentialsMessage.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#GUnixCredentialsMessage.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#GUnixCredentialsMessage.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="GUnixCredentialsMessage"></a><div class="titlepage"></div>
  35 <div class="refnamediv"><table width="100%"><tr>
  36 <td valign="top">
  37 <h2><span class="refentrytitle"><a name="GUnixCredentialsMessage.top_of_page"></a>GUnixCredentialsMessage</span></h2>
  38 <p>GUnixCredentialsMessage — A GSocketControlMessage containing credentials</p>
  39 </td>
  40 <td valign="top" align="right"></td>
  41 </tr></table></div>
  42 <div class="refsynopsisdiv">
  43 <a name="GUnixCredentialsMessage.synopsis"></a><h2>Synopsis</h2>
  44 <pre class="synopsis">
  45 #include &lt;gio/gunixcredentialsmessage.h&gt;
  46
  47                     <a class="link" href="GUnixCredentialsMessage.html#GUnixCredentialsMessage-struct" title="GUnixCredentialsMessage">GUnixCredentialsMessage</a>;
  48 struct              <a class="link" href="GUnixCredentialsMessage.html#GUnixCredentialsMessageClass" title="struct GUnixCredentialsMessageClass">GUnixCredentialsMessageClass</a>;
  49 <a class="link" href="GSocketControlMessage.html" title="GSocketControlMessage"><span class="returnvalue">GSocketControlMessage</span></a> * <a class="link" href="GUnixCredentialsMessage.html#g-unix-credentials-message-new" title="g_unix_credentials_message_new ()">g_unix_credentials_message_new</a>  (<em class="parameter"><code><span class="type">void</span></code></em>);
  50 <a class="link" href="GSocketControlMessage.html" title="GSocketControlMessage"><span class="returnvalue">GSocketControlMessage</span></a> * <a class="link" href="GUnixCredentialsMessage.html#g-unix-credentials-message-new-with-credentials" title="g_unix_credentials_message_new_with_credentials ()">g_unix_credentials_message_new_with_credentials</a>
  51                                                         (<em class="parameter"><code><a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a> *credentials</code></em>);
  52 <a class="link" href="GCredentials.html" title="GCredentials"><span class="returnvalue">GCredentials</span></a> *      <a class="link" href="GUnixCredentialsMessage.html#g-unix-credentials-message-get-credentials" title="g_unix_credentials_message_get_credentials ()">g_unix_credentials_message_get_credentials</a>
  53                                                         (<em class="parameter"><code><a class="link" href="GUnixCredentialsMessage.html" title="GUnixCredentialsMessage"><span class="type">GUnixCredentialsMessage</span></a> *message</code></em>);
  54 <a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GUnixCredentialsMessage.html#g-unix-credentials-message-is-supported" title="g_unix_credentials_message_is_supported ()">g_unix_credentials_message_is_supported</a>
  55                                                         (<em class="parameter"><code><span class="type">void</span></code></em>);
  56 </pre>
  57 </div>
  58 <div class="refsect1">
  59 <a name="GUnixCredentialsMessage.object-hierarchy"></a><h2>Object Hierarchy</h2>
  60 <pre class="synopsis">
  61   <a href="./../gobject/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  62    +----<a class="link" href="GSocketControlMessage.html" title="GSocketControlMessage">GSocketControlMessage</a>
  63          +----GUnixCredentialsMessage
  64 </pre>
  65 </div>
  66 <div class="refsect1">
  67 <a name="GUnixCredentialsMessage.properties"></a><h2>Properties</h2>
  68 <pre class="synopsis">
  69   "<a class="link" href="GUnixCredentialsMessage.html#GUnixCredentialsMessage--credentials" title='The "credentials" property'>credentials</a>"              <a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a>*         : Read / Write / Construct Only
  70 </pre>
  71 </div>
  72 <div class="refsect1">
  73 <a name="GUnixCredentialsMessage.description"></a><h2>Description</h2>
  74 <p>
  75 This <a class="link" href="GSocketControlMessage.html" title="GSocketControlMessage"><span class="type">GSocketControlMessage</span></a> contains a <a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a> instance.  It
  76 may be sent using <a class="link" href="GSocket.html#g-socket-send-message" title="g_socket_send_message ()"><code class="function">g_socket_send_message()</code></a> and received using
  77 <a class="link" href="GSocket.html#g-socket-receive-message" title="g_socket_receive_message ()"><code class="function">g_socket_receive_message()</code></a> over UNIX sockets (ie: sockets in the
  78 <a class="link" href="GSocketAddress.html#G-SOCKET-FAMILY-UNIX:CAPS"><code class="literal">G_SOCKET_FAMILY_UNIX</code></a> family).
  79 </p>
  80 <p>
  81 For an easier way to send and receive credentials over
  82 stream-oriented UNIX sockets, see
  83 <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
  84 <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>. To receive credentials of
  85 a foreign process connected to a socket, use
  86 <a class="link" href="GSocket.html#g-socket-get-credentials" title="g_socket_get_credentials ()"><code class="function">g_socket_get_credentials()</code></a>.
  87 </p>
  88 </div>
  89 <div class="refsect1">
  90 <a name="GUnixCredentialsMessage.details"></a><h2>Details</h2>
  91 <div class="refsect2">
  92 <a name="GUnixCredentialsMessage-struct"></a><h3>GUnixCredentialsMessage</h3>
  93 <pre class="programlisting">typedef struct _GUnixCredentialsMessage GUnixCredentialsMessage;</pre>
  94 <p>
  95 The <a class="link" href="GUnixCredentialsMessage.html" title="GUnixCredentialsMessage"><span class="type">GUnixCredentialsMessage</span></a> structure contains only private data
  96 and should only be accessed using the provided API.
  97 </p>
  98 <p class="since">Since 2.26</p>
  99 </div>
 100 <hr>
 101 <div class="refsect2">
 102 <a name="GUnixCredentialsMessageClass"></a><h3>struct GUnixCredentialsMessageClass</h3>
 103 <pre class="programlisting">struct GUnixCredentialsMessageClass {
 104   GSocketControlMessageClass parent_class;
 105 };
 106 </pre>
 107 <p>
 108 Class structure for <a class="link" href="GUnixCredentialsMessage.html" title="GUnixCredentialsMessage"><span class="type">GUnixCredentialsMessage</span></a>.
 109 </p>
 110 <p class="since">Since 2.26</p>
 111 </div>
 112 <hr>
 113 <div class="refsect2">
 114 <a name="g-unix-credentials-message-new"></a><h3>g_unix_credentials_message_new ()</h3>
 115 <pre class="programlisting"><a class="link" href="GSocketControlMessage.html" title="GSocketControlMessage"><span class="returnvalue">GSocketControlMessage</span></a> * g_unix_credentials_message_new  (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 116 <p>
 117 Creates a new <a class="link" href="GUnixCredentialsMessage.html" title="GUnixCredentialsMessage"><span class="type">GUnixCredentialsMessage</span></a> with credentials matching the current processes.
 118 </p>
 119 <div class="variablelist"><table border="0">
 120 <col align="left" valign="top">
 121 <tbody><tr>
 122 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 123 <td>a new <a class="link" href="GUnixCredentialsMessage.html" title="GUnixCredentialsMessage"><span class="type">GUnixCredentialsMessage</span></a>
 124 </td>
 125 </tr></tbody>
 126 </table></div>
 127 <p class="since">Since 2.26</p>
 128 </div>
 129 <hr>
 130 <div class="refsect2">
 131 <a name="g-unix-credentials-message-new-with-credentials"></a><h3>g_unix_credentials_message_new_with_credentials ()</h3>
 132 <pre class="programlisting"><a class="link" href="GSocketControlMessage.html" title="GSocketControlMessage"><span class="returnvalue">GSocketControlMessage</span></a> * g_unix_credentials_message_new_with_credentials
 133                                                         (<em class="parameter"><code><a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a> *credentials</code></em>);</pre>
 134 <p>
 135 Creates a new <a class="link" href="GUnixCredentialsMessage.html" title="GUnixCredentialsMessage"><span class="type">GUnixCredentialsMessage</span></a> holding <em class="parameter"><code>credentials</code></em>.
 136 </p>
 137 <div class="variablelist"><table border="0">
 138 <col align="left" valign="top">
 139 <tbody>
 140 <tr>
 141 <td><p><span class="term"><em class="parameter"><code>credentials</code></em> :</span></p></td>
 142 <td>A <a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a> object.</td>
 143 </tr>
 144 <tr>
 145 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 146 <td>a new <a class="link" href="GUnixCredentialsMessage.html" title="GUnixCredentialsMessage"><span class="type">GUnixCredentialsMessage</span></a>
 147 </td>
 148 </tr>
 149 </tbody>
 150 </table></div>
 151 <p class="since">Since 2.26</p>
 152 </div>
 153 <hr>
 154 <div class="refsect2">
 155 <a name="g-unix-credentials-message-get-credentials"></a><h3>g_unix_credentials_message_get_credentials ()</h3>
 156 <pre class="programlisting"><a class="link" href="GCredentials.html" title="GCredentials"><span class="returnvalue">GCredentials</span></a> *      g_unix_credentials_message_get_credentials
 157                                                         (<em class="parameter"><code><a class="link" href="GUnixCredentialsMessage.html" title="GUnixCredentialsMessage"><span class="type">GUnixCredentialsMessage</span></a> *message</code></em>);</pre>
 158 <p>
 159 Gets the credentials stored in <em class="parameter"><code>message</code></em>.
 160 </p>
 161 <div class="variablelist"><table border="0">
 162 <col align="left" valign="top">
 163 <tbody>
 164 <tr>
 165 <td><p><span class="term"><em class="parameter"><code>message</code></em> :</span></p></td>
 166 <td>A <a class="link" href="GUnixCredentialsMessage.html" title="GUnixCredentialsMessage"><span class="type">GUnixCredentialsMessage</span></a>.</td>
 167 </tr>
 168 <tr>
 169 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 170 <td>A <a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a> instance. Do not free, it is owned by <em class="parameter"><code>message</code></em>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 171 </td>
 172 </tr>
 173 </tbody>
 174 </table></div>
 175 <p class="since">Since 2.26</p>
 176 </div>
 177 <hr>
 178 <div class="refsect2">
 179 <a name="g-unix-credentials-message-is-supported"></a><h3>g_unix_credentials_message_is_supported ()</h3>
 180 <pre class="programlisting"><a href="./../glib/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            g_unix_credentials_message_is_supported
 181                                                         (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 182 <p>
 183 Checks if passing <a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a> on a <a class="link" href="GSocket.html" title="GSocket"><span class="type">GSocket</span></a> is supported on this platform.
 184 </p>
 185 <div class="variablelist"><table border="0">
 186 <col align="left" valign="top">
 187 <tbody><tr>
 188 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 189 <td>
 190 <a href="./../glib/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if supported, <a href="./../glib/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</td>
 191 </tr></tbody>
 192 </table></div>
 193 <p class="since">Since 2.26</p>
 194 </div>
 195 </div>
 196 <div class="refsect1">
 197 <a name="GUnixCredentialsMessage.property-details"></a><h2>Property Details</h2>
 198 <div class="refsect2">
 199 <a name="GUnixCredentialsMessage--credentials"></a><h3>The <code class="literal">"credentials"</code> property</h3>
 200 <pre class="programlisting">  "credentials"              <a class="link" href="GCredentials.html" title="GCredentials"><span class="type">GCredentials</span></a>*         : Read / Write / Construct Only</pre>
 201 <p>
 202 The credentials stored in the message.
 203 </p>
 204 <p class="since">Since 2.26</p>
 205 </div>
 206 </div>
 207 <div class="refsect1">
 208 <a name="GUnixCredentialsMessage.see-also"></a><h2>See Also</h2>
 209 <a class="link" href="GUnixConnection.html" title="GUnixConnection"><span class="type">GUnixConnection</span></a>, <a class="link" href="GSocketControlMessage.html" title="GSocketControlMessage"><span class="type">GSocketControlMessage</span></a>
 210 </div>
 211 </div>
 212 <div class="footer">
 213 <hr>
 214           Generated by GTK-Doc V1.18</div>
 215 </body>
 216 </html>