2003-04-27 Havoc Pennington <hp@pobox.com>
[platform/upstream/dbus.git] / bus / bus.h
1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* bus.h  message bus context object
3  *
4  * Copyright (C) 2003 Red Hat, Inc.
5  *
6  * Licensed under the Academic Free License version 1.2
7  * 
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  * 
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21  *
22  */
23
24 #ifndef BUS_BUS_H
25 #define BUS_BUS_H
26
27 #include <config.h>
28
29 #include <dbus/dbus.h>
30 #include <dbus/dbus-string.h>
31 #include <dbus/dbus-mainloop.h>
32 #include <dbus/dbus-userdb.h>
33
34 typedef struct BusActivation    BusActivation;
35 typedef struct BusConnections   BusConnections;
36 typedef struct BusContext       BusContext;
37 typedef struct BusPolicy        BusPolicy;
38 typedef struct BusClientPolicy  BusClientPolicy;
39 typedef struct BusPolicyRule    BusPolicyRule;
40 typedef struct BusRegistry      BusRegistry;
41 typedef struct BusService       BusService;
42 typedef struct BusTransaction   BusTransaction;
43
44
45 typedef struct
46 {
47   long max_incoming_bytes;          /**< How many incoming messages for a single connection */
48   long max_outgoing_bytes;          /**< How many outgoing bytes can be queued for a single connection */
49   long max_message_size;            /**< Max size of a single message in bytes */
50   int activation_timeout;           /**< How long to wait for an activation to time out */
51   int auth_timeout;                 /**< How long to wait for an authentication to time out */
52   int max_completed_connections;    /**< Max number of authorized connections */
53   int max_incomplete_connections;   /**< Max number of incomplete connections */
54   int max_connections_per_user;     /**< Max number of connections auth'd as same user */
55   int max_pending_activations;      /**< Max number of pending activations for the entire bus */
56   int max_services_per_connection;  /**< Max number of owned services for a single connection */
57 } BusLimits;
58
59 BusContext*       bus_context_new                             (const DBusString *config_file,
60                                                                int               print_addr_fd,
61                                                                DBusError        *error);
62 void              bus_context_shutdown                        (BusContext       *context);
63 void              bus_context_ref                             (BusContext       *context);
64 void              bus_context_unref                           (BusContext       *context);
65 const char*       bus_context_get_type                        (BusContext       *context);
66 const char*       bus_context_get_address                     (BusContext       *context);
67 BusRegistry*      bus_context_get_registry                    (BusContext       *context);
68 BusConnections*   bus_context_get_connections                 (BusContext       *context);
69 BusActivation*    bus_context_get_activation                  (BusContext       *context);
70 DBusLoop*         bus_context_get_loop                        (BusContext       *context);
71 DBusUserDatabase* bus_context_get_user_database               (BusContext       *context);
72 dbus_bool_t       bus_context_allow_user                      (BusContext       *context,
73                                                                unsigned long     uid);
74 BusClientPolicy*  bus_context_create_client_policy            (BusContext       *context,
75                                                                DBusConnection   *connection,
76                                                                DBusError        *error);
77
78 int               bus_context_get_activation_timeout          (BusContext       *context);
79 int               bus_context_get_auth_timeout                (BusContext       *context);
80 int               bus_context_get_max_completed_connections   (BusContext       *context);
81 int               bus_context_get_max_incomplete_connections  (BusContext       *context);
82 int               bus_context_get_max_connections_per_user    (BusContext       *context);
83 int               bus_context_get_max_pending_activations     (BusContext       *context);
84 int               bus_context_get_max_services_per_connection (BusContext       *context);
85 dbus_bool_t       bus_context_check_security_policy           (BusContext       *context,
86                                                                DBusConnection   *sender,
87                                                                DBusConnection   *recipient,
88                                                                DBusMessage      *message,
89                                                                DBusError        *error);
90
91 #endif /* BUS_BUS_H */