chiark / gitweb /
libsystemd-dhcp: Use be32_t for IP addresses in network order.
[elogind.git] / man / sd_session_is_active.xml
index 9362fbcc55e7a916a1d8b82e3a3cbc53d1cf28d2..d94ae196ab6e1db7c9cac6c205abc7e9d820e2ae 100644 (file)
                                 <paramdef>const char* <parameter>session</parameter></paramdef>
                         </funcprototype>
 
+                        <funcprototype>
+                                <funcdef>int <function>sd_session_is_remote</function></funcdef>
+                                <paramdef>const char* <parameter>session</parameter></paramdef>
+                        </funcprototype>
+
                         <funcprototype>
                                 <funcdef>int <function>sd_session_get_state</function></funcdef>
                                 <paramdef>const char* <parameter>session</parameter></paramdef>
                                 <paramdef>char** <parameter>display</parameter></paramdef>
                         </funcprototype>
 
+                        <funcprototype>
+                                <funcdef>int <function>sd_session_get_remote_host</function></funcdef>
+                                <paramdef>const char* <parameter>session</parameter></paramdef>
+                                <paramdef>char** <parameter>remote_host</parameter></paramdef>
+                        </funcprototype>
+
+                        <funcprototype>
+                                <funcdef>int <function>sd_session_get_remote_user</function></funcdef>
+                                <paramdef>const char* <parameter>session</parameter></paramdef>
+                                <paramdef>char** <parameter>remote_user</parameter></paramdef>
+                        </funcprototype>
+
                         <funcprototype>
                                 <funcdef>int <function>sd_session_get_tty</function></funcdef>
                                 <paramdef>const char* <parameter>session</parameter></paramdef>
                         <funcprototype>
                                 <funcdef>int <function>sd_session_get_vt</function></funcdef>
                                 <paramdef>const char* <parameter>session</parameter></paramdef>
-                                <paramdef>unsigned* <parameter>vt</parameter></paramdef>
+                                <paramdef>unsigned int* <parameter>vt</parameter></paramdef>
                         </funcprototype>
                 </funcsynopsis>
         </refsynopsisdiv>
                 (i.e. currently in the foreground and available for
                 user input) or not.</para>
 
+                <para><function>sd_session_is_remote()</function> may
+                be used to determine whether the session identified by
+                the specified session identifier is a remote session
+                (i.e. its remote host is known) or not.</para>
+
                 <para><function>sd_session_get_state()</function> may
                 be used to determine the state of the session
                 identified by the specified session identifier. The
                 <citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
                 call after use.</para>
 
+                <para><function>sd_session_get_remote_host()</function>
+                may be used to determine the remote hostname of the
+                session identified by the specified session
+                identifier. The returned string needs to be
+                freed with the libc
+                <citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+                call after use.</para>
+
+                <para><function>sd_session_get_remote_user()</function>
+                may be used to determine the remote username of the
+                session identified by the specified session
+                identifier. The returned string needs to be
+                freed with the libc
+                <citerefentry><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+                call after use. Note that this value is rarely known
+                to the system, and even then should not be relied on.</para>
+
                 <para><function>sd_session_get_tty()</function>
                 may be used to determine the TTY device of the
                 session identified by the specified session
 
                 <para>If the <varname>session</varname> parameter of
                 any of these functions is passed as
-                <constant>NULL</constant> the operation is executed
+                <constant>NULL</constant>, the operation is executed
                 for the session the calling process is a member of, if
                 there is any.</para>
         </refsect1>
         <refsect1>
                 <title>Return Value</title>
 
-                <para>If the test succeeds
-                <function>sd_session_is_active()</function> returns a
+                <para>If the test succeeds,
+                <function>sd_session_is_active()</function> and
+                <function>sd_session_is_remote()</function> return a
                 positive integer, if it fails 0.  On success
                 <function>sd_session_get_state()</function>,
                 <function>sd_session_get_uid()</function>,
                 <function>sd_session_get_service()</function>,
                 <function>sd_session_get_type()</function>,
                 <function>sd_session_get_class()</function>,
-                <function>sd_session_get_display()</function> and
+                <function>sd_session_get_display()</function>,
+                <function>sd_session_get_remote_user()</function>,
+                <function>sd_session_get_remote_host()</function> and
                 <function>sd_session_get_tty()</function> return 0 or
                 a positive integer. On failure, these calls return a
                 negative errno-style error code.</para>
                 <function>sd_session_get_service()</function>,
                 <function>sd_session_get_type()</function>,
                 <function>sd_session_get_class()</function>,
-                <function>sd_session_get_display()</function> and
+                <function>sd_session_get_display()</function>,
+                <function>sd_session_get_remote_host()</function>,
+                <function>sd_session_get_remote_user()</function> and
                 <function>sd_session_get_tty()</function>
                 interfaces are available as shared library, which can
                 be compiled and linked to with the