summaryrefslogtreecommitdiff
path: root/man/sd_session_is_active.xml
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2012-06-21 16:31:06 +0200
committerLennart Poettering <lennart@poettering.net>2012-06-21 16:31:06 +0200
commit7ea9cb91207f49965bc23bfdac9d5475940bea51 (patch)
tree304c01d3ea16935cd4e1ae3f1ddb32c9071623c0 /man/sd_session_is_active.xml
parent0604381b9dbef4cc498b5a77311e1da99c1430b8 (diff)
man: document new sd_session_get_state() call
Diffstat (limited to 'man/sd_session_is_active.xml')
-rw-r--r--man/sd_session_is_active.xml26
1 files changed, 26 insertions, 0 deletions
diff --git a/man/sd_session_is_active.xml b/man/sd_session_is_active.xml
index 45151aaaf9..f9b2874541 100644
--- a/man/sd_session_is_active.xml
+++ b/man/sd_session_is_active.xml
@@ -44,6 +44,7 @@
<refnamediv>
<refname>sd_session_is_active</refname>
+ <refname>sd_session_get_state</refname>
<refname>sd_session_get_uid</refname>
<refname>sd_session_get_seat</refname>
<refname>sd_session_get_service</refname>
@@ -63,6 +64,12 @@
</funcprototype>
<funcprototype>
+ <funcdef>int <function>sd_session_get_state</function></funcdef>
+ <paramdef>const char* <parameter>session</parameter></paramdef>
+ <paramdef>char** <parameter>state</parameter></paramdef>
+ </funcprototype>
+
+ <funcprototype>
<funcdef>int <function>sd_session_get_uid</function></funcdef>
<paramdef>const char* <parameter>session</parameter></paramdef>
<paramdef>uid_t* <parameter>uid</parameter></paramdef>
@@ -109,6 +116,25 @@
(i.e. currently in the foreground and available for
user input) 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
+ following states are currently known:
+ <literal>online</literal> (session logged in, but
+ session not active, i.e. not in the foreground),
+ <literal>active</literal> (session logged in and
+ active, i.e. in the foreground),
+ <literal>closing</literal> (session nominally logged
+ out, but some processes belonging to it are still
+ around). In the future additional states might be
+ defined, client code should be written to be robust in
+ regards to additional state strings being
+ returned. This function is a more generic version of
+ <function>sd_session_is_active()</function>. 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_uid()</function> may be
used to determine the user identifier of the Unix user the session
identified by the specified session identifier belongs