From 8b42a4928a0a266c3b3ae6bb13997764bc7f6405 Mon Sep 17 00:00:00 2001
From: William Jon McCann Table of Contents Table of Contents Version 0.1.3 Table of Contents Table of Contents Table of Contents
ConsoleKit is a framework for keeping track of the various
users, sessions, and seats present on a system. It
provides a mechanism for software to react to changes of any of
these items or of any of the metadata associated with them.
- Table of Contents Table of Contents
ConsoleKit provides a D-Bus API for programs to obtain information about the
users, sessions, and seats that are present on a system.
@@ -15,82 +15,274 @@
these concepts.
This API is not yet stable and is likely to change in the future.
- Table of Contents org.freedesktop.ConsoleKit.Manager — Manager interface Table of Contents org.freedesktop.ConsoleKit.Manager — Manager interface org.freedesktop.ConsoleKit.Manager implements
+GetSystemIdleHint (out 'b' idle_hint)
+GetSystemIdleSinceHint (out 's' iso8601_datetime)
+ org.freedesktop.ConsoleKit.Manager implements
org.freedesktop.DBus.Introspectable,
org.freedesktop.DBus.Properties
- org.freedesktop.ConsoleKit.Seat — Seat interface This method requests that a new Session
+ be created for the calling process. The properties of this new Session are set automatically
+ from information collected about the calling process.
+ This new session exists until the calling process disconnects from the system bus or
+ calls It is the responsibility of the calling process to set the environment variable
+ XDG_SESSION_COOKIE to the value of the returned cookie. This cookie should only
+ be made available to child processes of the caller so that they may be identified
+ as members of this session.
+ See this simple example:
+
+See also:
+ This method requests that a new Session
+ be created for the calling process. The properties of this new Session are from the
+ parameters provided.
+ This new session exists until the calling process disconnects from the system bus or
+ calls It is the responsibility of the calling process to set the environment variable
+ XDG_SESSION_COOKIE to the value of the returned cookie. This cookie should only
+ be made available to child processes of the caller so that they may be identified
+ as members of this session.
+ See the Session properties for a list of valid parameters.
+See also:
+org.freedesktop.ConsoleKit.Session This method is used to close the session identified by the supplied cookie.
+ The session can only be closed by the same process that opened the session.
+ This gets a list of all the Seats
+ that are currently present on the system. Each Seat ID is an D-Bus object path for the object that implements the
+ Seat interface.
+See also:
+org.freedesktop.ConsoleKit.Seat Returns the session ID that is associated with the specified cookie.
+ Attempts to determine the session ID for the specified
+ POSIX process ID (pid).
+ Attempts to determine the session ID that the caller belongs to.
+ See this example of using dbus-send:
+ This gets a list of all the Sessions
+ that are currently open for the specified user. Each Session ID is an D-Bus object path for the object that implements the
+ Session interface. Returns TRUE if the Returns an ISO 8601 date-time string that corresponds to
+ the time of the last change of the system-idle-hint.
+ org.freedesktop.ConsoleKit.Seat — Seat interface org.freedesktop.ConsoleKit.Seat implements
org.freedesktop.DBus.Introspectable,
org.freedesktop.DBus.Properties
- org.freedesktop.ConsoleKit.Session — Session interface
+
+ A seat is a collection of sessions and a set of hardware (usually at
+least a keyboard and mouse). Only one session may be active on a
+seat at a time.
+
+ This gets a list of all the Sessions
+ that are currently attached to this seat. Each Session ID is an D-Bus object path for the object that implements the
+ Session interface. Gets the Session ID that is currently active on this Seat. Returns NULL if there is no active session. Attempt to activate the specified session. In most
+ cases, if successful, this will cause the session to
+ become visible and take control of the hardware that is
+ associated with this seat.
+See also:
+ org.freedesktop.ConsoleKit.Session — Session interface org.freedesktop.ConsoleKit.Session implements
org.freedesktop.DBus.Introspectable,
org.freedesktop.DBus.Properties
- Name
Methods
OpenSession (out 's' cookie)
-OpenSessionWithParameters (in 'a(sv)' parameters,
+
Name
Methods
OpenSession (out 's' cookie)
+OpenSessionWithParameters (in 'a(sv)' parameters,
out 's' cookie)
-CloseSession (in 's' cookie,
+CloseSession (in 's' cookie,
out 'b' result)
-GetSeats (out 'ao' seats)
-GetCurrentSession (out 'o' ssid)
-GetSessionForCookie (in 's' cookie,
+GetSeats (out 'ao' seats)
+GetSessionForCookie (in 's' cookie,
out 'o' ssid)
-GetSessionForUnixProcess (in 'u' pid,
+GetSessionForUnixProcess (in 'u' pid,
out 'o' ssid)
-GetSessionsForUser (in 'u' uid,
+GetCurrentSession (out 'o' ssid)
+GetSessionsForUser (in 'u' uid,
out 'ao' sessions)
-GetSystemIdleHint (out 'b' idle_hint)
-GetSystemIdleSinceHint (out 's' iso8601_datetime)
-
Implemented Interfaces
Implemented Interfaces
Name
Methods
GetId (out 'o' sid)
-GetSessions (out 'ao' sessions)
-GetActiveSession (out 'o' ssid)
-ActivateSession (in 'o' ssid)
-
Details
CloseSession()
.
+
+ DBusError error;
+ DBusMessage *message;
+ DBusMessage *reply;
+
+ message = dbus_message_new_method_call ("org.freedesktop.ConsoleKit",
+ "/org/freedesktop/ConsoleKit/Manager",
+ "org.freedesktop.ConsoleKit.Manager",
+ "OpenSession");
+ if (message == NULL) {
+ goto out;
+ }
+
+ dbus_error_init (&error);
+ reply = dbus_connection_send_with_reply_and_block (connector->connection,
+ message,
+ -1,
+ &error);
+ if (reply == NULL) {
+ goto out;
+ }
+
+ dbus_error_init (&error);
+ if (! dbus_message_get_args (reply,
+ &error,
+ DBUS_TYPE_STRING, &cookie,
+ DBUS_TYPE_INVALID)) {
+ goto out;
+ }
+
+
cookie
:OpenSessionWithParameters()
CloseSession()
.
+ parameters
:cookie
:cookie
:result
:seats
:cookie
:ssid
:pid
:ssid
:
+ dbus-send --system --dest=org.freedesktop.ConsoleKit \
+ --type=method_call --print-reply --reply-timeout=2000 \
+ /org/freedesktop/ConsoleKit/Manager \
+ org.freedesktop.ConsoleKit.Manager.GetCurrentSession
+
ssid
:uid
:sessions
:idle-hint
+ property of every open session is TRUE or if there are no open sessions.
+ idle_hint
:iso8601_datetime
:Name
Methods
GetId (out 'o' sid)
+GetSessions (out 'ao' sessions)
+GetActiveSession (out 'o' ssid)
+ActivateSession (in 'o' ssid)
+
Implemented Interfaces
Name
Methods
GetId (out 'o' ssid)
-GetSeatId (out 'o' sid)
-GetSessionType (out 's' type)
-GetUser (out 'i' uid)
-GetX11Display (out 's' display)
-GetX11DisplayDevice (out 's' x11_display_device)
-GetDisplayDevice (out 's' display_device)
-GetRemoteHostName (out 's' remote_host_name)
-IsActive (out 'b' active)
-IsLocal (out 'b' local)
-GetCreationTime (out 's' iso8601_datetime)
-Activate ()
-Lock ()
-Unlock ()
-GetIdleHint (out 'b' idle_hint)
-GetIdleSinceHint (out 's' iso8601_datetime)
-SetIdleHint (in 'b' idle_hint)
-
Description
Details
Returns the ID for Seat.
+ sid
:sessions
:ssid
:ssid
:Activate()
Name
Methods
GetId (out 'o' ssid)
+GetSeatId (out 'o' sid)
+GetSessionType (out 's' type)
+GetUser (out 'i' uid)
+GetX11Display (out 's' display)
+GetX11DisplayDevice (out 's' x11_display_device)
+GetDisplayDevice (out 's' display_device)
+GetRemoteHostName (out 's' remote_host_name)
+IsActive (out 'b' active)
+IsLocal (out 'b' local)
+GetCreationTime (out 's' iso8601_datetime)
+Activate ()
+Lock ()
+Unlock ()
+GetIdleHint (out 'b' idle_hint)
+GetIdleSinceHint (out 's' iso8601_datetime)
+SetIdleHint (in 'b' idle_hint)
+
Implemented Interfaces
Properties
'user' readwrite 'u'
-'session-type' readwrite 's'
-'remote-host-name' readwrite 's'
-'display-device' readwrite 's'
-'x11-display' readwrite 's'
-'x11-display-device' readwrite 's'
-'active' readwrite 'b'
-'is-local' readwrite 'b'
-'idle-hint' readwrite 'b'
-
A
C
D
G
I
O
R
S
X
'user' readwrite 'u' +'session-type' readwrite 's' +'remote-host-name' readwrite 's' +'display-device' readwrite 's' +'x11-display' readwrite 's' +'x11-display-device' readwrite 's' +'active' readwrite 'b' +'is-local' readwrite 'b' +'idle-hint' readwrite 'b' +
+ +
Session objects represent and store information + related to a user session. +
+
The properties associated with the Session + specifically refer to the properties of the "session leader". +
+ +
Returns the ID for Session.
ssid
:Returns the ID for the Seat the Session is + attached to.
sid
:+See also: +org.freedesktop.ConsoleKit.Seat
Returns the type of the session.
Warning: we haven't yet defined the allowed values for this property. + It is probably best to avoid this until we do. +
type
:
+See also:
+session-type
Returns the user that the session belongs to.
uid
:
+See also:
+user
Returns the value of the X11 DISPLAY for this session + if one is present.
display
:
+See also:
+x11-display
Returns the value of the display device (aka TTY) that the + X11 display for the session is connected to. If there is no x11-display set then this value + is undefined.
x11_display_device
:
+See also:
+x11-display-device
Returns the value of the display device (aka TTY) that the + session is connected to.
display_device
:
+See also:
+display-device
Returns the value of the remote host name for the session. +
remote_host_name
:
+See also:
+remote-host-name
Returns whether the session is active on the Seat that + it is attached to.
If the session is not attached to a seat this value is undefined. +
active
:
+See also:
+active
Returns whether the session is local
FIXME: we need to come up with a concrete definition for this value. + It was originally used as a way to identify XDMCP sessions that originate + from a remote system. +
local
:
+See also:
+is-local
Returns an ISO 8601 date-time string that corresponds to + the time that the session was opened. +
iso8601_datetime
:Attempt to activate the this session. In most + cases, if successful, this will cause the session to + become visible and become active on the seat that it + is attached to.
+See also:
+Seat.ActivateSession()
This will cause a Lock
+ signal to be emitted for this session.
+
+See also:
+Lock signal
This will cause an Unlock
+ signal to be emitted for this session.
+
This can be used by login managers to unlock a session before it is + re-activated during fast-user-switching. +
+See also:
+Unlock signal
Gets the value of the idle-hint
+ property.
+
idle_hint
:
+See also:
+idle-hint
Returns an ISO 8601 date-time string that corresponds to + the time of the last change of the idle-hint. +
iso8601_datetime
:This may be used by the session to indicate that + it is idle. +
Use of this method is restricted to the user + that owns the session.
idle_hint
:Emitted when the active property has changed.
is_active
:Emitted when the idle-hint property has changed.
hint
:Emitted in response to a call to the Lock()
method.
It is intended that the screensaver for the session should lock the screen in response to this signal.
Emitted in response to a call to the Unlock()
method.
It is intended that the screensaver for the session should unlock the screen in response to this signal.
The user assigned to the session.
The type of the session.
Warning: we haven't yet defined the allowed values for this property. + It is probably best to avoid this until we do. +
The remote host name for the session. +
This will be set in situations where the session is + opened and controlled from a remote system. +
For example, this value will be set when the + session is created from an SSH or XDMCP connection. +
The display device (aka TTY) that the + session is connected to. +
Value of the X11 DISPLAY for this session + if one is present. +
+ The display device (aka TTY) that the X11 display for the + session is connected to. If there is no x11-display set then + this value is undefined. +
+ Whether the session is active on the Seat that + it is attached to.
If the session is not attached to a seat this value is undefined. +
+ Whether the session is local
FIXME: we need to come up with a concrete definition for this value. + It was originally used as a way to identify XDMCP sessions that originate + from a remote system. +
+ This is a hint used to indicate that the session may be idle. +
+ For sessions with a x11-display
set (ie. graphical
+ sessions), it is up to each session to delegate the
+ responsibility for updating this value. Typically, the
+ screensaver will set this.
+
However, for non-graphical sessions with a display-device
set
+ the Session object itself will periodically update this value based
+ on the activity detected on the display-device itself.
+
+ This should not be considered authoritative. +