Top | ![]() |
![]() |
![]() |
![]() |
EDBusServerExitCode | e_dbus_server_run () |
void | e_dbus_server_quit () |
void | e_dbus_server_hold () |
void | e_dbus_server_release () |
void | e_dbus_server_load_modules () |
void | bus-acquired | Run Last |
void | bus-name-acquired | Run Last |
void | bus-name-lost | Run Last |
void | quit-server | Run Last |
EDBusServerExitCode | run-server | Run Last |
EDBusServerExitCode e_dbus_server_run (EDBusServer *server
,gboolean wait_for_client
);
Emits the “run” signal.
By default the server
will start its main loop and attempt to acquire
its well-known session bus name. If the server
's main loop is already
running, the function will immediately return E_DBUS_SERVER_EXIT_NONE.
Otherwise the function blocks until e_dbus_server_quit()
is called.
If wait_for_client
is TRUE
, the server
will continue running until
the first client connection is made instead of quitting on its own if
no client connection is made within the first few seconds.
Since 3.4
void e_dbus_server_quit (EDBusServer *server
,EDBusServerExitCode code
);
Emits the “quit” signal with the given code
.
By default the server
will quit its main loop and cause
e_dbus_server_run()
to return code
.
Since 3.4
void
e_dbus_server_hold (EDBusServer *server
);
Increases the use count of server
.
Use this function to indicate that the server has a reason to continue
to run. To cancel the hold, call e_dbus_server_release()
.
Since 3.4
void
e_dbus_server_release (EDBusServer *server
);
Decreates the use count of server
.
When the use count reaches zero, the server will stop running.
Never call this function except to cancel the effect of a previous call
to e_dbus_server_hold()
.
Since 3.4
void
e_dbus_server_load_modules (EDBusServer *server
);
This function should be called once during server
initialization to
load all available library modules to extend the server
's functionality.
Since 3.4
struct EDBusServer;
Contains only private data that should be read and manipulated using the functions below.
Since 3.4
Exit codes submitted to e_dbus_server_quit()
and returned by
e_dbus_server_run()
.
The server's run state is unchanged. |
||
Normal termination. The process itself may now terminate. |
||
The server should reload its configuration and start again. Servers that do not support reloading may wish to intercept this exit code and stop the “quit-server” emission. |
Since 3.6
“bus-acquired”
signalvoid user_function (EDBusServer *server, GDBusConnection *connection, gpointer user_data)
Emitted when server
acquires a connection to the session bus.
server |
the EDBusServer which emitted the signal |
|
connection |
the GDBusConnection to the session bus |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“bus-name-acquired”
signalvoid user_function (EDBusServer *server, GDBusConnection *connection, gpointer user_data)
Emitted when server
acquires its well-known session bus name.
server |
the EDBusServer which emitted the signal |
|
connection |
the GDBusConnection to the session bus |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“bus-name-lost”
signalvoid user_function (EDBusServer *server, GDBusConnection *connection, gpointer user_data)
Emitted when server
loses its well-known session bus name
or the session bus connection has been closed.
server |
the EDBusServer which emitted the signal |
|
connection |
the GDBusconnection to the session bus,
or |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“quit-server”
signalvoid user_function (EDBusServer *server, EDBusServerExitCode code, gpointer user_data)
Emitted to request that server
quit its main loop.
server |
the EDBusServer which emitted the signal |
|
code |
||
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“run-server”
signalEDBusServerExitCode user_function (EDBusServer *server, gpointer user_data)
Emitted to request that server
start its main loop and
attempt to acquire its well-known session bus name.
server |
the EDBusServer which emitted the signal |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last