/usr/include/rest-0.7/rest/rest-proxy.h is in librest-dev 0.8.0-2.
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 | /*
* librest - RESTful web services access
* Copyright (c) 2008, 2009, Intel Corporation.
*
* Authors: Rob Bradford <rob@linux.intel.com>
* Ross Burton <ross@linux.intel.com>
*
* This program is free software; you can redistribute it and/or modify it
* under the terms and conditions of the GNU Lesser General Public License,
* version 2.1, as published by the Free Software Foundation.
*
* This program is distributed in the hope 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 program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
*
*/
#ifndef _REST_PROXY
#define _REST_PROXY
#include <glib-object.h>
#include <libsoup/soup-session-feature.h>
#include <rest/rest-proxy-auth.h>
#include <rest/rest-proxy-call.h>
G_BEGIN_DECLS
#define REST_TYPE_PROXY rest_proxy_get_type()
#define REST_PROXY(obj) \
(G_TYPE_CHECK_INSTANCE_CAST ((obj), REST_TYPE_PROXY, RestProxy))
#define REST_PROXY_CLASS(klass) \
(G_TYPE_CHECK_CLASS_CAST ((klass), REST_TYPE_PROXY, RestProxyClass))
#define REST_IS_PROXY(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE ((obj), REST_TYPE_PROXY))
#define REST_IS_PROXY_CLASS(klass) \
(G_TYPE_CHECK_CLASS_TYPE ((klass), REST_TYPE_PROXY))
#define REST_PROXY_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_CLASS ((obj), REST_TYPE_PROXY, RestProxyClass))
typedef struct _RestProxy RestProxy;
typedef struct _RestProxyClass RestProxyClass;
/**
* RestProxy:
*
* #RestProxy has no publicly available members.
*/
struct _RestProxy {
GObject parent;
};
/**
* RestProxyClass:
* @bind_valist: Virtual function called to bind parameters.
* @new_call: Virtual function called to construct a new #RestProxyCall.
* @simple_run_valist: Virtual function called when making a "simple" call.
* @authenticate: class handler for the #RestProxy::authenticate signal
*
* Class structure for #RestProxy for subclasses to implement specialised
* behaviour.
*
* Typically subclasses will override @new_call to construct a subclass of
* #RestProxyCall.
*/
struct _RestProxyClass {
/*< private >*/
GObjectClass parent_class;
/*< public >*/
gboolean (*bind_valist)(RestProxy *proxy, va_list params);
RestProxyCall *(*new_call)(RestProxy *proxy);
gboolean (*simple_run_valist)(RestProxy *proxy, gchar **payload,
goffset *len, GError **error, va_list params);
gboolean (*authenticate)(RestProxy *proxy, RestProxyAuth *auth, gboolean retrying);
/*< private >*/
/* padding for future expansion */
gpointer _padding_dummy[7];
};
#define REST_PROXY_ERROR rest_proxy_error_quark ()
/**
* RestProxyError:
* @REST_PROXY_ERROR_CANCELLED: Cancelled
* @REST_PROXY_ERROR_RESOLUTION: Resolution
* @REST_PROXY_ERROR_CONNECTION: Connection
* @REST_PROXY_ERROR_SSL: SSL
* @REST_PROXY_ERROR_IO: Input/Output
* @REST_PROXY_ERROR_FAILED: Failure
* @REST_PROXY_ERROR_HTTP_MULTIPLE_CHOICES: HTTP/Multiple choices
* @REST_PROXY_ERROR_HTTP_MOVED_PERMANENTLY: HTTP/Moved permanently
* @REST_PROXY_ERROR_HTTP_FOUND: HTTP/Found
* @REST_PROXY_ERROR_HTTP_SEE_OTHER: HTTP/See other
* @REST_PROXY_ERROR_HTTP_NOT_MODIFIED: HTTP/Not modified
* @REST_PROXY_ERROR_HTTP_USE_PROXY: HTTP/Use proxy
* @REST_PROXY_ERROR_HTTP_THREEOHSIX: HTTP/306
* @REST_PROXY_ERROR_HTTP_TEMPORARY_REDIRECT: HTTP/Temporary redirect
* @REST_PROXY_ERROR_HTTP_BAD_REQUEST: HTTP/Bad request
* @REST_PROXY_ERROR_HTTP_UNAUTHORIZED: HTTP/Unauthorized
* @REST_PROXY_ERROR_HTTP_FOUROHTWO: HTTP/402
* @REST_PROXY_ERROR_HTTP_FORBIDDEN: HTTP/Forbidden
* @REST_PROXY_ERROR_HTTP_NOT_FOUND: HTTP/Not found
* @REST_PROXY_ERROR_HTTP_METHOD_NOT_ALLOWED: HTTP/Method not allowed
* @REST_PROXY_ERROR_HTTP_NOT_ACCEPTABLE: HTTP/Not acceptable
* @REST_PROXY_ERROR_HTTP_PROXY_AUTHENTICATION_REQUIRED: HTTP/Proxy authentication required
* @REST_PROXY_ERROR_HTTP_REQUEST_TIMEOUT: HTTP/Request timeout
* @REST_PROXY_ERROR_HTTP_CONFLICT: HTTP/Conflict
* @REST_PROXY_ERROR_HTTP_GONE: HTTP/Gone
* @REST_PROXY_ERROR_HTTP_LENGTH_REQUIRED: HTTP/Length required
* @REST_PROXY_ERROR_HTTP_PRECONDITION_FAILED: HTTP/Precondition failed
* @REST_PROXY_ERROR_HTTP_REQUEST_ENTITY_TOO_LARGE: HTTP/Request entity too large
* @REST_PROXY_ERROR_HTTP_REQUEST_URI_TOO_LONG: HTTP/Request URI too long
* @REST_PROXY_ERROR_HTTP_UNSUPPORTED_MEDIA_TYPE: HTTP/Unsupported media type
* @REST_PROXY_ERROR_HTTP_REQUESTED_RANGE_NOT_SATISFIABLE: HTTP/Requested range not satisfiable
* @REST_PROXY_ERROR_HTTP_EXPECTATION_FAILED: HTTP/Expectation failed
* @REST_PROXY_ERROR_HTTP_INTERNAL_SERVER_ERROR: HTTP/Internal server error
* @REST_PROXY_ERROR_HTTP_NOT_IMPLEMENTED: HTTP/Not implemented
* @REST_PROXY_ERROR_HTTP_BAD_GATEWAY: HTTP/Bad gateway
* @REST_PROXY_ERROR_HTTP_SERVICE_UNAVAILABLE: HTTP/Service unavailable
* @REST_PROXY_ERROR_HTTP_GATEWAY_TIMEOUT: HTTP/Gateway timeout
* @REST_PROXY_ERROR_HTTP_HTTP_VERSION_NOT_SUPPORTED: HTTP/Version not supported
*
* Error domain used when returning errors from a #RestProxy.
*/
typedef enum {
REST_PROXY_ERROR_CANCELLED = 1,
REST_PROXY_ERROR_RESOLUTION,
REST_PROXY_ERROR_CONNECTION,
REST_PROXY_ERROR_SSL,
REST_PROXY_ERROR_IO,
REST_PROXY_ERROR_FAILED,
REST_PROXY_ERROR_HTTP_MULTIPLE_CHOICES = 300,
REST_PROXY_ERROR_HTTP_MOVED_PERMANENTLY = 301,
REST_PROXY_ERROR_HTTP_FOUND = 302,
REST_PROXY_ERROR_HTTP_SEE_OTHER = 303,
REST_PROXY_ERROR_HTTP_NOT_MODIFIED = 304,
REST_PROXY_ERROR_HTTP_USE_PROXY = 305,
REST_PROXY_ERROR_HTTP_THREEOHSIX = 306,
REST_PROXY_ERROR_HTTP_TEMPORARY_REDIRECT = 307,
REST_PROXY_ERROR_HTTP_BAD_REQUEST = 400,
REST_PROXY_ERROR_HTTP_UNAUTHORIZED = 401,
REST_PROXY_ERROR_HTTP_FOUROHTWO = 402,
REST_PROXY_ERROR_HTTP_FORBIDDEN = 403,
REST_PROXY_ERROR_HTTP_NOT_FOUND = 404,
REST_PROXY_ERROR_HTTP_METHOD_NOT_ALLOWED = 405,
REST_PROXY_ERROR_HTTP_NOT_ACCEPTABLE = 406,
REST_PROXY_ERROR_HTTP_PROXY_AUTHENTICATION_REQUIRED = 407,
REST_PROXY_ERROR_HTTP_REQUEST_TIMEOUT = 408,
REST_PROXY_ERROR_HTTP_CONFLICT = 409,
REST_PROXY_ERROR_HTTP_GONE = 410,
REST_PROXY_ERROR_HTTP_LENGTH_REQUIRED = 411,
REST_PROXY_ERROR_HTTP_PRECONDITION_FAILED = 412,
REST_PROXY_ERROR_HTTP_REQUEST_ENTITY_TOO_LARGE = 413,
REST_PROXY_ERROR_HTTP_REQUEST_URI_TOO_LONG = 414,
REST_PROXY_ERROR_HTTP_UNSUPPORTED_MEDIA_TYPE = 415,
REST_PROXY_ERROR_HTTP_REQUESTED_RANGE_NOT_SATISFIABLE = 416,
REST_PROXY_ERROR_HTTP_EXPECTATION_FAILED = 417,
REST_PROXY_ERROR_HTTP_INTERNAL_SERVER_ERROR = 500,
REST_PROXY_ERROR_HTTP_NOT_IMPLEMENTED = 501,
REST_PROXY_ERROR_HTTP_BAD_GATEWAY = 502,
REST_PROXY_ERROR_HTTP_SERVICE_UNAVAILABLE = 503,
REST_PROXY_ERROR_HTTP_GATEWAY_TIMEOUT = 504,
REST_PROXY_ERROR_HTTP_HTTP_VERSION_NOT_SUPPORTED = 505,
} RestProxyError;
GQuark rest_proxy_error_quark (void);
GType rest_proxy_get_type (void);
RestProxy *rest_proxy_new (const gchar *url_format,
gboolean binding_required);
RestProxy *
rest_proxy_new_with_authentication (const gchar *url_format,
gboolean binding_required,
const gchar *username,
const gchar *password);
gboolean rest_proxy_bind (RestProxy *proxy,
...);
gboolean rest_proxy_bind_valist (RestProxy *proxy,
va_list params);
void rest_proxy_set_user_agent (RestProxy *proxy, const char *user_agent);
const gchar *rest_proxy_get_user_agent (RestProxy *proxy);
void rest_proxy_add_soup_feature (RestProxy *proxy,
SoupSessionFeature *feature);
RestProxyCall *rest_proxy_new_call (RestProxy *proxy);
G_GNUC_NULL_TERMINATED
gboolean rest_proxy_simple_run (RestProxy *proxy,
gchar **payload,
goffset *len,
GError **error,
...);
gboolean rest_proxy_simple_run_valist (RestProxy *proxy,
gchar **payload,
goffset *len,
GError **error,
va_list params);
G_END_DECLS
#endif /* _REST_PROXY */
|