dbus/dbus-transport.h

   1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
   2 /* dbus-transport.h DBusTransport object (internal to D-BUS implementation)
   3  *
   4  * Copyright (C) 2002, 2004  Red Hat Inc.
   5  *
   6  * Licensed under the Academic Free License version 2.1
   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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  21  *
  22  */
  23 #ifndef DBUS_TRANSPORT_H
  24 #define DBUS_TRANSPORT_H
  25
  26 #include <dbus/dbus-internals.h>
  27 #include <dbus/dbus-connection.h>
  28 #include <dbus/dbus-protocol.h>
  29 #include <dbus/dbus-address.h>
  30
  31 DBUS_BEGIN_DECLS
  32
  33 typedef struct DBusTransport DBusTransport;
  34
  35 DBusTransport*     _dbus_transport_open                   (DBusAddressEntry           *entry,
  36                                                            DBusError                  *error);
  37 DBusTransport*     _dbus_transport_ref                    (DBusTransport              *transport);
  38 void               _dbus_transport_unref                  (DBusTransport              *transport);
  39 void               _dbus_transport_disconnect             (DBusTransport              *transport);
  40 dbus_bool_t        _dbus_transport_get_is_connected       (DBusTransport              *transport);
  41 dbus_bool_t        _dbus_transport_peek_is_authenticated  (DBusTransport              *transport);
  42 dbus_bool_t        _dbus_transport_try_to_authenticate    (DBusTransport              *transport);
  43 dbus_bool_t        _dbus_transport_get_is_anonymous       (DBusTransport              *transport);
  44 dbus_bool_t        _dbus_transport_can_pass_unix_fd       (DBusTransport              *transport);
  45
  46 const char*        _dbus_transport_get_address            (DBusTransport              *transport);
  47 const char*        _dbus_transport_get_server_id          (DBusTransport              *transport);
  48 dbus_bool_t        _dbus_transport_handle_watch           (DBusTransport              *transport,
  49                                                            DBusWatch                  *watch,
  50                                                            unsigned int                condition);
  51 dbus_bool_t        _dbus_transport_set_connection         (DBusTransport              *transport,
  52                                                            DBusConnection             *connection);
  53 void               _dbus_transport_do_iteration           (DBusTransport              *transport,
  54                                                            unsigned int                flags,
  55                                                            int                         timeout_milliseconds);
  56 DBusDispatchStatus _dbus_transport_get_dispatch_status    (DBusTransport              *transport);
  57 dbus_bool_t        _dbus_transport_queue_messages         (DBusTransport              *transport);
  58
  59 void               _dbus_transport_set_max_message_size   (DBusTransport              *transport,
  60                                                            long                        size);
  61 long               _dbus_transport_get_max_message_size   (DBusTransport              *transport);
  62 void               _dbus_transport_set_max_received_size  (DBusTransport              *transport,
  63                                                            long                        size);
  64 long               _dbus_transport_get_max_received_size  (DBusTransport              *transport);
  65
  66 void               _dbus_transport_set_max_message_unix_fds (DBusTransport              *transport,
  67                                                              long                        n);
  68 long               _dbus_transport_get_max_message_unix_fds (DBusTransport              *transport);
  69 void               _dbus_transport_set_max_received_unix_fds(DBusTransport              *transport,
  70                                                              long                        n);
  71 long               _dbus_transport_get_max_received_unix_fds(DBusTransport              *transport);
  72
  73 dbus_bool_t        _dbus_transport_get_socket_fd          (DBusTransport              *transport,
  74                                                            int                        *fd_p);
  75 dbus_bool_t        _dbus_transport_get_unix_user          (DBusTransport              *transport,
  76                                                            unsigned long              *uid);
  77 dbus_bool_t        _dbus_transport_get_unix_process_id     (DBusTransport              *transport,
  78                                                            unsigned long              *pid);
  79 dbus_bool_t        _dbus_transport_get_adt_audit_session_data (DBusTransport              *transport,
  80                                                                void                      **data,
  81                                                                int                        *data_size);
  82 void               _dbus_transport_set_unix_user_function (DBusTransport              *transport,
  83                                                            DBusAllowUnixUserFunction   function,
  84                                                            void                       *data,
  85                                                            DBusFreeFunction            free_data_function,
  86                                                            void                      **old_data,
  87                                                            DBusFreeFunction           *old_free_data_function);
  88 dbus_bool_t        _dbus_transport_get_windows_user       (DBusTransport              *transport,
  89                                                            char                      **windows_sid_p);
  90 void               _dbus_transport_set_windows_user_function (DBusTransport              *transport,
  91                                                               DBusAllowWindowsUserFunction   function,
  92                                                               void                       *data,
  93                                                               DBusFreeFunction            free_data_function,
  94                                                               void                      **old_data,
  95                                                               DBusFreeFunction           *old_free_data_function);
  96 dbus_bool_t        _dbus_transport_set_auth_mechanisms    (DBusTransport              *transport,
  97                                                            const char                **mechanisms);
  98 void               _dbus_transport_set_allow_anonymous    (DBusTransport              *transport,
  99                                                            dbus_bool_t                 value);
 100
 101 #ifdef ENABLE_KDBUS_TRANSPORT
 102 DBUS_EXPORT
 103 DBusTransport*  dbus_connection_get_transport      (DBusConnection *connection);
 104 #endif
 105
 106 /* if DBUS_ENABLE_STATS */
 107 void _dbus_transport_get_stats (DBusTransport  *transport,
 108                                 dbus_uint32_t  *queue_bytes,
 109                                 dbus_uint32_t  *queue_fds,
 110                                 dbus_uint32_t  *peak_queue_bytes,
 111                                 dbus_uint32_t  *peak_queue_fds);
 112
 113 DBUS_END_DECLS
 114
 115 #endif /* DBUS_TRANSPORT_H */