c76929052d4371a44764a8219bfd09ffeb5025a2
[platform/upstream/dbus.git] / dbus / dbus-connection.h
1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-connection.h DBusConnection object
3  *
4  * Copyright (C) 2002  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 #if !defined (DBUS_INSIDE_DBUS_H) && !defined (DBUS_COMPILATION)
24 #error "Only <dbus/dbus.h> can be included directly, this file may disappear or change contents."
25 #endif
26
27 #ifndef DBUS_CONNECTION_H
28 #define DBUS_CONNECTION_H
29
30 #include <dbus/dbus-errors.h>
31 #include <dbus/dbus-message.h>
32 #include <dbus/dbus-memory.h>
33
34 DBUS_BEGIN_DECLS;
35
36 typedef struct DBusConnection DBusConnection;
37 typedef struct DBusWatch DBusWatch;
38 typedef struct DBusMessageHandler DBusMessageHandler;
39
40 typedef enum
41 {
42   DBUS_HANDLER_RESULT_REMOVE_MESSAGE,     /**< Remove this message, no further processing. */
43   DBUS_HANDLER_RESULT_ALLOW_MORE_HANDLERS /**< Run any additional handlers that are interested on this message. */
44 } DBusHandlerResult;
45
46 typedef enum
47 {
48   DBUS_WATCH_READABLE = 1 << 0, /**< As in POLLIN */
49   DBUS_WATCH_WRITABLE = 1 << 1, /**< As in POLLOUT */
50   DBUS_WATCH_ERROR    = 1 << 2, /**< As in POLLERR (can't watch for this, but
51                                  *   the flag can be passed to dbus_connection_handle_watch()).
52                                  */
53   DBUS_WATCH_HANGUP   = 1 << 3  /**< As in POLLHUP (can't watch for it, but
54                                  *   can be present in current state). */
55 } DBusWatchFlags;
56
57 typedef void (* DBusAddWatchFunction)    (DBusWatch      *watch,
58                                           void           *data);
59
60 typedef void (* DBusRemoveWatchFunction) (DBusWatch      *watch,
61                                           void           *data);
62
63 typedef void (* DBusConnectionErrorFunction) (DBusConnection *connection,
64                                               DBusResultCode  error_code,
65                                               void           *data);
66
67 DBusConnection* dbus_connection_open             (const char     *address,
68                                                   DBusResultCode *result);
69 void            dbus_connection_ref              (DBusConnection *connection);
70 void            dbus_connection_unref            (DBusConnection *connection);
71 void            dbus_connection_disconnect       (DBusConnection *connection);
72 dbus_bool_t     dbus_connection_get_is_connected (DBusConnection *connection);
73 void            dbus_connection_flush            (DBusConnection *connection);
74
75 int          dbus_connection_get_n_messages      (DBusConnection *connection);
76 DBusMessage* dbus_connection_peek_message        (DBusConnection *connection);
77 DBusMessage* dbus_connection_pop_message         (DBusConnection *connection);
78 dbus_bool_t  dbus_connection_dispatch_message    (DBusConnection *connection);
79
80 dbus_bool_t dbus_connection_send_message            (DBusConnection     *connection,
81                                                      DBusMessage        *message,
82                                                      DBusResultCode     *result);
83 dbus_bool_t dbus_connection_send_message_with_reply (DBusConnection     *connection,
84                                                      DBusMessage        *message,
85                                                      DBusMessageHandler *reply_handler,
86                                                      int                 timeout_milliseconds,
87                                                      DBusResultCode     *result);
88
89 void dbus_connection_set_error_function  (DBusConnection              *connection,
90                                           DBusConnectionErrorFunction  error_function,
91                                           void                        *data,
92                                           DBusFreeFunction             free_data_function);
93 void dbus_connection_set_watch_functions (DBusConnection              *connection,
94                                           DBusAddWatchFunction         add_function,
95                                           DBusRemoveWatchFunction      remove_function,
96                                           void                        *data,
97                                           DBusFreeFunction             free_data_function);
98 void dbus_connection_handle_watch        (DBusConnection              *connection,
99                                           DBusWatch                   *watch,
100                                           unsigned int                 condition);
101
102 int          dbus_watch_get_fd    (DBusWatch        *watch);
103 unsigned int dbus_watch_get_flags (DBusWatch        *watch);
104 void*        dbus_watch_get_data  (DBusWatch        *watch);
105 void         dbus_watch_set_data  (DBusWatch        *watch,
106                                    void             *data,
107                                    DBusFreeFunction  free_data_function);
108
109
110 /* Handlers */
111 dbus_bool_t dbus_connection_add_filter         (DBusConnection      *connection,
112                                                 DBusMessageHandler  *handler);
113 void        dbus_connection_remove_filter      (DBusConnection      *connection,
114                                                 DBusMessageHandler  *handler);
115
116 dbus_bool_t dbus_connection_register_handler   (DBusConnection      *connection,
117                                                 DBusMessageHandler  *handler,
118                                                 const char         **messages_to_handle,
119                                                 int                  n_messages);
120 void        dbus_connection_unregister_handler (DBusConnection      *connection,
121                                                 DBusMessageHandler  *handler,
122                                                 const char         **messages_to_handle,
123                                                 int                  n_messages);
124
125
126 int         dbus_connection_allocate_data_slot (void);
127 void        dbus_connection_free_data_slot     (int               slot);
128 dbus_bool_t dbus_connection_set_data           (DBusConnection   *connection,
129                                                 int               slot,
130                                                 void             *data,
131                                                 DBusFreeFunction  free_data_func);
132 void*       dbus_connection_get_data           (DBusConnection   *connection,
133                                                 int               slot);
134
135 DBUS_END_DECLS;
136
137 #endif /* DBUS_CONNECTION_H */