/usr/include/cutter/soupcutter/soupcut-client.h is in libsoupcutter-dev 1.1.7-1.1.
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 | /* -*- Mode: C; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* Copyright (C) 2009 Yuto HAYAMIZU <y.hayamizu@gmail.com>
*
* 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 3 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 program. If not, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef __SOUPCUT_CLIENT_H__
#define __SOUPCUT_CLIENT_H__
#include <glib-object.h>
#include <libsoup/soup.h>
G_BEGIN_DECLS
/**
* SECTION: soupcut-client
* @title: Convenience HTTP client API
* @short_description: API to work as HTTP client.
* @see_also: <link
* linkend="cutter-Assertions-for-HTTP-client-and-server">
* Assertions for HTTP client and server</link>
*
* #SoupCutClient works as a HTTP client. It accepts
* multiple requests and responses are managed by
* #SoupCutClient. #SoupCutClient related assertions are
* also provided.
*/
#define SOUPCUT_TYPE_CLIENT (soupcut_client_get_type ())
#define SOUPCUT_CLIENT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), SOUPCUT_TYPE_CLIENT, SoupCutClient))
#define SOUPCUT_CLIENT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), SOUPCUT_TYPE_CLIENT, SoupCutClientClass))
#define SOUPCUT_IS_CLIENT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), SOUPCUT_TYPE_CLIENT))
#define SOUPCUT_IS_CLIENT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), SOUPCUT_TYPE_CLIENT))
#define SOUPCUT_CLIENT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), SOUPCUT_TYPE_CLIENT, SoupCutClientClass))
typedef struct _SoupCutClient SoupCutClient;
typedef struct _SoupCutClientClass SoupCutClientClass;
struct _SoupCutClient
{
GObject object;
};
struct _SoupCutClientClass
{
GObjectClass parent_class;
};
GType soupcut_client_get_type (void) G_GNUC_CONST;
/**
* soupcut_client_new:
*
* Creates and returns a new #SoupCutClient
*
* Returns: a new #SoupCutClient.
*
* Since: 1.0.8
*/
SoupCutClient *soupcut_client_new (void);
/**
* soupcut_client_set_base:
* @client: a #SoupCutClient.
* @uri: a base uri.
*
* Set @uri as a base uri of @client.
*
* Since: 1.0.8
*/
void soupcut_client_set_base (SoupCutClient *client,
const gchar *uri);
/**
* soupcut_client_send_message:
* @client: a #SoupCutClient.
* @message: a #SoupMessage.
*
* Send @message with @client. @client remebers all the messages it sent.
*
* Returns: a status code of the response.
*
* Since: 1.0.8
*/
guint soupcut_client_send_message (SoupCutClient *client,
SoupMessage *message);
/**
* soupcut_client_get:
* @client: a #SoupCutClient.
* @uri: an URI string.
* @first_query_name: the name of the first query parameter.
* @...: pairs of query parameter names and values, starting with @first_query_name, terminated by %NULL
*
* Send a GET request to @uri with queries. If the base URI of @client
* is set by soupcut_client_set_base(), the destination URI is composed of the base URI and @uri. If not, @uri must be a fully qualified URI.
*
* Returns: a status code of the response.
*
* Since: 1.0.8
*/
guint soupcut_client_get (SoupCutClient *client,
const gchar *uri,
const gchar *first_query_name,
...);
/**
* soupcut_client_get_n_messages:
* @client: a #SoupCutClient.
*
* Returns the number of messages @client sent.
*
* Returns: the number of messages.
*
* Since: 1.0.8
*/
guint soupcut_client_get_n_messages (SoupCutClient *client);
/**
* soupcut_client_get_latest_message:
* @client: a #SoupCutClient.
*
* Returns the latest #SoupMessage @client sent.
*
* Returns: the latest #SoupMessage.
*
* Since: 1.0.8
*/
SoupMessage *soupcut_client_get_latest_message (SoupCutClient *client);
/**
* soupcut_client_get_async_context:
* @client: a #SoupCutClient.
*
* Returns the asynch_context of @client.
*
* Returns: a #GMainContext of @client, which may be %NULL.
*
* Since: 1.0.8
*/
GMainContext *soupcut_client_get_async_context (SoupCutClient *client);
G_END_DECLS
#endif /* __SOUPCUT_CLIENT_H__ */
/*
vi:ts=4:nowrap:ai:expandtab:sw=4
*/
|