1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
// -*- Mode: C++; indent-tabs-mode: nil; c-basic-offset: 2 -*-
/* Copyright (C) 2010 The giomm Development Team
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include <giomm/dbusconnection.h>
_DEFS(giomm,gio)
namespace Gio
{
namespace DBus
{
namespace Address
{
/** Checks if @a string is a D-Bus address.
*
* This doesn't check if @a string is actually supported by BusServer or
* BusConnection - use is_supported_address() to do more checks.
*
* @param string A string.
* @return <tt>true</tt> if @a string is a valid D-Bus address, <tt>false</tt>
* otherwise.
* @newin{2,28}
* @ingroup DBus
*/
bool is_address(const std::string& string);
/** Like is_address() but also checks if the library supports the transports
* in @a address and that key/value pairs for each transport are valid.
*
* @param address A supposed address.
* @return <tt>true</tt> if @a address is a valid D-Bus address that is
* supported by this library, <tt>false</tt> otherwise.
* @throw Glib::Error.
* @newin{2,28}
* @ingroup DBus
*/
bool is_supported(const std::string& address);
/** Asynchronously connects to an endpoint specified by @a address and sets up
* the connection so it is in a state to run the client-side of the D-Bus
* authentication conversation.
*
* When the operation is finished, @a slot will be invoked. You can then call
* get_stream_finish() to get the result of the operation.
*
* This is an asynchronous failable function. See get_stream_sync() for the
* synchronous version.
*
* @param address A valid D-Bus address.
* @param cancellable A Cancellable.
* @param slot A SlotAsyncReady to call when the request is satisfied.
* @newin{2,28}
* @ingroup DBus
*/
void get_stream(const std::string& address, const SlotAsyncReady slot,
const Glib::RefPtr<Cancellable>& cancellable);
/// A non-cancellable version of get_stream().
void get_stream(const std::string& address, const SlotAsyncReady slot);
/** Finishes an operation started with get_stream().
*
* @param res A AsyncResult obtained from the SlotAsyncReady passed to
* get_stream().
* @param out_guid Return location to store the GUID extracted from address,
* if any.
* @return A IOStream.
* @throw Glib::Error.
* @newin{2,28}
* @ingroup DBus
*/
Glib::RefPtr<IOStream> get_stream_finish(const Glib::RefPtr<AsyncResult>& res,
std::string& out_guid);
/** Finishes an operation started with get_stream().
*
* @param res A AsyncResult obtained from the SlotAsyncReady passed to
* get_stream().
* @return A IOStream.
* @throw Glib::Error.
* @newin{2,28}
* @ingroup DBus
*/
Glib::RefPtr<IOStream> get_stream_finish(const Glib::RefPtr<AsyncResult>& res);
/** Synchronously connects to an endpoint specified by @a address and sets up
* the connection so it is in a state to run the client-side of the D-Bus
* authentication conversation.
*
* This is a synchronous failable function. See get_stream() for the
* asynchronous version.
*
* @param address A valid D-Bus address.
* @param cancellable A Cancellable.
* @param out_guid A return location to store the GUID extracted from address,
* if any.
* @return A IOStream.
* @throw Glib::Error.
* @newin{2,28}
* @ingroup DBus
*/
Glib::RefPtr<IOStream> get_stream_sync(const std::string& address,
const Glib::RefPtr<Cancellable>& cancellable, std::string& out_guid);
/// A non-cancellable version of get_stream_sync().
Glib::RefPtr<IOStream> get_stream_sync(const std::string& address,
std::string& out_guid);
/** Synchronously connects to an endpoint specified by @a address and sets up
* the connection so it is in a state to run the client-side of the D-Bus
* authentication conversation.
*
* This is a synchronous failable function. See get_stream() for the
* asynchronous version.
*
* @param address A valid D-Bus address.
* @param cancellable A Cancellable.
* @return A IOStream.
* @throw Glib::Error.
* @newin{2,28}
* @ingroup DBus
*/
Glib::RefPtr<IOStream> get_stream_sync(const std::string& address,
const Glib::RefPtr<Cancellable>& cancellable);
/// A non-cancellable version of get_stream_sync().
Glib::RefPtr<IOStream> get_stream_sync(const std::string& address);
/** Synchronously looks up the D-Bus address for the well-known message bus
* instance specified by @a bus_type. This may involve using various platform
* specific mechanisms.
*
* @param bus_type A BusType.
* @param cancellable A Cancellable.
* @return A valid D-Bus address string for @a bus_type.
* @throw Glib::Error.
* @newin{2,28}
* @ingroup DBus
*/
std::string get_for_bus_sync(BusType bus_type,
const Glib::RefPtr<Cancellable>& cancellable);
/// A non-cancellable get_for_bus_sync().
std::string get_for_bus_sync(BusType bus_type);
} // namespace Address
} // namespace DBus
} // namespace Gio
|
