/usr/include/kxmlrpcclient/client.h is in kdepimlibs5-dev 4:4.14.10-7+b2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 | /******************************************************************************
* Copyright (C) 2003 - 2004 by Frerich Raabe <raabe@kde.org> *
* Tobias Koenig <tokoe@kde.org> *
* Copyright (C) 2006 by Narayan Newton <narayannewton@gmail.com> *
* *
* This program 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. For licensing and distribution *
* details, check the accompanying file 'COPYING.BSD'. *
*****************************************************************************/
/**
@file
This file is part of the API for accessing XML-RPC Servers
and defines the Client class.
@brief
Defines the Client class.
@author Frerich Raabe <raabe@kde.org>
@author Tobias Koenig <tokoe@kde.org>
@author Narayan Newton <narayannewton@gmail.com>
*/
#ifndef KXML_RPC_CLIENT_H
#define KXML_RPC_CLIENT_H
#include "kxmlrpcclient_export.h"
#include <kurl.h>
#include <QtCore/QList>
#include <QtCore/QObject>
#include <QtCore/QVariant>
/** Names for XmlRpc related classes */
namespace KXmlRpc {
/**
@brief
A class that represents a connection to a XML-RPC server.
This is the main interface to the XML-RPC client library.
@code
KXmlRpc::Client *c = new Client(KUrl( "http://localhost" ), this);
c->setUserAgent( "Test/1.0" );
c->call( "xmlrpc.command1", "Hi!",
this, SLOT( gotData( const QList<QVariant>&, const QVariant ) ),
this, SLOT( gotError( const QString&, const QVariant& ) ) );
@endcode
@author Narayan Newton <narayannewton@gmail.com>
*/
class KXMLRPCCLIENT_EXPORT Client : public QObject
{
Q_OBJECT
public:
/**
Constructs a XML-RPC Client.
@param parent the parent of this object, defaults to NULL.
*/
explicit Client( QObject *parent = 0 );
/**
Constructs a XML-RPC Client, which will connect to @p url.
@param url the url of the xml-rpc server.
@param parent the parent of this object, defaults to NULL.
*/
explicit Client( const KUrl &url, QObject *parent = 0 );
/**
Destroys the XML-RPC Client.
*/
~Client();
/**
Returns the current url the XML-RPC Client will connect to.
@see setUrl()
*/
KUrl url() const;
/**
Sets the url the Client will connect to.
@param url the url for the xml-rpc server we will be connecting to.
@see url()
*/
void setUrl( const KUrl &url );
/**
Returns the user agent string currently used by the Client.
@see setUserAgent()
*/
QString userAgent() const;
/**
Sets the userAgent string the Client will use to identify itself.
@param userAgent the user agent string to use.
@see userAgent()
*/
void setUserAgent( const QString &userAgent );
/**
Returns true if HTTP-Digest authentication is enabled, false
if not.
@see setDigestAuthEnabled()
*/
bool isDigestAuthEnabled() const;
/**
Enables/disables HTTP-Digest authentication
@see isDigestAuthEnabled()
*/
void setDigestAuthEnabled( bool enabled );
public Q_SLOTS:
/**
Calls the given method on a XML-RPC server, with the given
argument list.
@param method the method on the server we are going to be calling
@param args the argument list to pass to the server
@param msgObj the object containing the data slot
@param messageSlot the data slot itself
@param faultObj the object containing the error slot
@param faultSlot the error slot itself
@param id the id for our #Client object, defaults to empty
*/
void call( const QString &method, const QList<QVariant> &args,
QObject *msgObj, const char *messageSlot,
QObject *faultObj, const char *faultSlot,
const QVariant &id = QVariant() );
/**
Calls the given method on a XML-RPC server, with the given
argument.
@param method the method on the server we are going to be calling
@param arg the argument to pass to the server
@param msgObj the object containing the data slot
@param messageSlot the data slot itself
@param faultObj the object containing the error slot
@param faultSlot the error slot itself
@param id the id for our Client object, defaults to empty
*/
void call( const QString &method, const QVariant &arg,
QObject *msgObj, const char *messageSlot,
QObject *faultObj, const char *faultSlot,
const QVariant &id = QVariant() );
/**
Calls the given method on a XML-RPC server, with the given
int as the argument.
@param method the method on the server we are going to be calling
@param arg the int to pass to the server
@param msgObj the object containing the data slot
@param messageSlot the data slot itself
@param faultObj the object containing the error slot
@param faultSlot the error slot itself
@param id the id for our Client object, defaults to empty
*/
void call( const QString &method, int arg,
QObject *msgObj, const char *messageSlot,
QObject *faultObj, const char *faultSlot,
const QVariant &id = QVariant() );
/**
Calls the given method on a XML-RPC server, with the given
bool as the argument.
@param method the method on the server we are going to be calling
@param arg the bool to pass to the server
@param msgObj the object containing the data slot
@param messageSlot the data slot itself
@param faultObj the object containing the error slot
@param faultSlot the error slot itself
@param id the id for our Client object, defaults to empty
*/
void call( const QString &method, bool arg,
QObject *msgObj, const char *messageSlot,
QObject *faultObj, const char *faultSlot,
const QVariant &id = QVariant() );
/**
Calls the given method on a XML-RPC server, with the given
double as the argument.
@param method the method on the server we are going to be calling
@param arg the double to pass to the server
@param msgObj the object containing the data slot
@param messageSlot the data slot itself
@param faultObj the object containing the error slot
@param faultSlot the error slot itself
@param id the id for our Client object, defaults to empty
*/
void call( const QString &method, double arg,
QObject *msgObj, const char *messageSlot,
QObject *faultObj, const char *faultSlot,
const QVariant &id = QVariant() );
/**
Calls the given method on a XML-RPC server, with the given
string as the argument.
@param method the method on the server we are going to be calling
@param arg the string to pass to the server
@param msgObj the object containing the data slot
@param messageSlot the data slot itself
@param faultObj the object containing the error slot
@param faultSlot the error slot itself
@param id the id for our Client object, defaults to empty
*/
void call( const QString &method, const QString &arg,
QObject *msgObj, const char *messageSlot,
QObject *faultObj, const char *faultSlot,
const QVariant &id = QVariant() );
/**
Calls the given method on a XML-RPC server, with the given
byte array as the argument.
@param method the method on the server we are going to be calling
@param arg the array to pass to the server
@param msgObj the object containing the data slot
@param messageSlot the data slot itself
@param faultObj the object containing the error slot
@param faultSlot the error slot itself
@param id the id for our Client object, defaults to empty
*/
void call( const QString &method, const QByteArray &arg,
QObject *msgObj, const char *messageSlot,
QObject *faultObj, const char *faultSlot,
const QVariant &id = QVariant() );
/**
Calls the given method on a XML-RPC server, with the given
date as the argument
@param method the method on the server we are going to be calling
@param arg the date and/or time to pass to the server
@param msgObj the object containing the data slot
@param messageSlot the data slot itself
@param faultObj the object containing the error slot
@param faultSlot the error slot itself
@param id the id for our Client object, defaults to empty
*/
void call( const QString &method, const QDateTime &arg,
QObject *msgObj, const char *messageSlot,
QObject *faultObj, const char *faultSlot,
const QVariant &id = QVariant() );
/**
Calls the given method on a XML-RPC server, with the given
string list as the argument
@param method the method on the server we are going to be calling
@param arg the list of strings to pass to the server
@param msgObj the object containing the data slot
@param messageSlot the data slot itself
@param faultObj the object containing the error slot
@param faultSlot the error slot itself
@param id the id for our Client object, defaults to empty
*/
void call( const QString &method, const QStringList &arg,
QObject *msgObj, const char *messageSlot,
QObject *faultObj, const char *faultSlot,
const QVariant &id = QVariant() );
private:
class Private;
Private *const d;
template <typename T>
void call( const QString &method, const QList<T> &arg,
QObject *obj1, const char *messageSlot,
QObject *obj2, const char *faultSlot,
const QVariant &id = QVariant() );
Q_PRIVATE_SLOT( d, void queryFinished( Query * ) )
};
/**
Calls the given method on a XML-RPC server with the given
list of type T arguments.
@param method the method on the server we are going to be calling
@param arg the list of type T to pass to the server
@param msgObj the object containing the data slot
@param messageSlot the data slot itself
@param faultObj the object containing the error slot
@param faultSlot the error slot itself
@param id the id for our Client object, defaults to empty
*/
template <typename T>
void Client::call( const QString &method, const QList<T> &arg,
QObject *msgObj, const char *messageSlot,
QObject *faultObj, const char *faultSlot,
const QVariant &id )
{
QList<QVariant> args;
for ( int i = 0; i < arg.count(); ++i ) {
args << QVariant( arg[ i ] );
}
return call( method, args, faultObj, faultSlot, msgObj, messageSlot, id );
}
}
#endif
|