| Evolution-Data-Server Manual: Backend Utilities (libebackend) | ||||
|---|---|---|---|---|
| Top | Description | Object Hierarchy | Implemented Interfaces | Signals | ||||
#include <libebackend/e-dbus-server> struct EDBusServer; enum EDBusServerExitCode; EDBusServerExitCode e_dbus_server_run (EDBusServer *server,gboolean wait_for_client); void e_dbus_server_quit (EDBusServer *server,EDBusServerExitCode code); void e_dbus_server_hold (EDBusServer *server); void e_dbus_server_release (EDBusServer *server); void e_dbus_server_load_modules (EDBusServer *server);
"bus-acquired" :Run Last"bus-name-acquired" :Run Last"bus-name-lost" :Run Last"quit-server" :Run Last"run-server" :Run Last
struct EDBusServer;
Contains only private data that should be read and manipulated using the functions below.
Since 3.4
typedef enum {
E_DBUS_SERVER_EXIT_NONE,
E_DBUS_SERVER_EXIT_NORMAL,
E_DBUS_SERVER_EXIT_RELOAD
} EDBusServerExitCode;
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
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.
|
an EDBusServer |
|
continue running until a client connects |
Returns : |
the exit code passed to e_dbus_server_quit()
|
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.
|
an EDBusServer |
|
an EDBusServerExitCode |
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().
|
an EDBusServer |
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().
|
an EDBusServer |
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.
|
an EDBusServer |
Since 3.4
"bus-acquired" signalvoid user_function (EDBusServer *server,
GDBusConnection *connection,
gpointer user_data) : Run Last
Emitted when server acquires a connection to the session bus.
|
the EDBusServer which emitted the signal |
|
the GDBusConnection to the session bus |
|
user data set when the signal handler was connected. |
"bus-name-acquired" signalvoid user_function (EDBusServer *server,
GDBusConnection *connection,
gpointer user_data) : Run Last
Emitted when server acquires its well-known session bus name.
|
the EDBusServer which emitted the signal |
|
the GDBusConnection to the session bus |
|
user data set when the signal handler was connected. |
"bus-name-lost" signalvoid user_function (EDBusServer *server,
GDBusConnection *connection,
gpointer user_data) : Run Last
Emitted when server loses its well-known session bus name
or the session bus connection has been closed.
|
the EDBusServer which emitted the signal |
|
the GDBusconnection to the session bus,
or NULL if the connection has been closed |
|
user data set when the signal handler was connected. |
"quit-server" signalvoid user_function (EDBusServer *server,
EDBusServerExitCode code,
gpointer user_data) : Run Last
Emitted to request that server quit its main loop.
|
the EDBusServer which emitted the signal |
|
an EDBusServerExitCode |
|
user data set when the signal handler was connected. |
"run-server" signalEDBusServerExitCode user_function (EDBusServer *server,
gpointer user_data) : Run Last
Emitted to request that server start its main loop and
attempt to acquire its well-known session bus name.
|
the EDBusServer which emitted the signal |
|
user data set when the signal handler was connected. |
Returns : |
an EDBusServerExitCode |