Blame docs/reference/html/SoupRequest.html

rpm-build 4f3c61
rpm-build 4f3c61
<html>
rpm-build 4f3c61
<head>
rpm-build 4f3c61
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
rpm-build 4f3c61
<title>SoupRequest: libsoup Reference Manual</title>
rpm-build 4f3c61
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
rpm-build 4f3c61
<link rel="home" href="index.html" title="libsoup Reference Manual">
rpm-build 4f3c61
<link rel="up" href="ch02.html" title="Core API">
rpm-build 4f3c61
<link rel="prev" href="SoupMultipartInputStream.html" title="SoupMultipartInputStream">
rpm-build 4f3c61
<link rel="next" href="SoupRequestHTTP.html" title="SoupRequestHTTP">
rpm-build 4f3c61
<meta name="generator" content="GTK-Doc V1.28.1 (XML mode)">
rpm-build 4f3c61
<link rel="stylesheet" href="style.css" type="text/css">
rpm-build 4f3c61
</head>
rpm-build 4f3c61
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
Top  | 
rpm-build 4f3c61
                  Description  | 
rpm-build 4f3c61
                  Object Hierarchy  | 
rpm-build 4f3c61
                  Implemented Interfaces  | 
rpm-build 4f3c61
                  Properties
rpm-build 4f3c61
rpm-build 4f3c61
Home
rpm-build 4f3c61
Up
rpm-build 4f3c61
Prev
rpm-build 4f3c61
Next
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61

SoupRequest

rpm-build 4f3c61

SoupRequest — Protocol-independent streaming request interface

rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61

Functions

rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
GInputStream *
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
soup_request_send ()
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
void
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
soup_request_send_async ()
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
GInputStream *
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
soup_request_send_finish ()
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
goffset
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
soup_request_get_content_length ()
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
const char *
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
soup_request_get_content_type ()
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
SoupSession *
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
soup_request_get_session ()
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
SoupURI *
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
soup_request_get_uri ()
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61

Properties

rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
SoupSession *
rpm-build 4f3c61
session
rpm-build 4f3c61
Read / Write / Construct Only
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
SoupURI *
rpm-build 4f3c61
uri
rpm-build 4f3c61
Read / Write / Construct Only
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61

Types and Values

rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
 
rpm-build 4f3c61
SoupRequest
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
#define
rpm-build 4f3c61
SOUP_REQUEST_SESSION
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
#define
rpm-build 4f3c61
SOUP_REQUEST_URI
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61

Object Hierarchy

rpm-build 4f3c61
    GObject
rpm-build 4f3c61
    ╰── SoupRequest
rpm-build 4f3c61
        ├── SoupRequestData
rpm-build 4f3c61
        ├── SoupRequestFile
rpm-build 4f3c61
        ╰── SoupRequestHTTP
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61

Implemented Interfaces

rpm-build 4f3c61

rpm-build 4f3c61
SoupRequest implements
rpm-build 4f3c61
 GInitable.

rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61

Includes

rpm-build 4f3c61
#include <libsoup/soup.h>
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61

Description

rpm-build 4f3c61

A SoupRequest is created by SoupSession, and represents a request

rpm-build 4f3c61
to retrieve a particular URI.

rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61

Functions

rpm-build 4f3c61
rpm-build 4f3c61

soup_request_send ()

rpm-build 4f3c61
GInputStream *
rpm-build 4f3c61
soup_request_send (SoupRequest *request,
rpm-build 4f3c61
                   GCancellable *cancellable,
rpm-build 4f3c61
                   GError **error);
rpm-build 4f3c61

Synchronously requests the URI pointed to by request

rpm-build 4f3c61
, and returns
rpm-build 4f3c61
a GInputStream that can be used to read its contents.

rpm-build 4f3c61

Note that you cannot use this method with SoupRequests attached to

rpm-build 4f3c61
a SoupSessionAsync.

rpm-build 4f3c61
rpm-build 4f3c61

Parameters

rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61

request

rpm-build 4f3c61

a SoupRequest

rpm-build 4f3c61
 
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61

cancellable

rpm-build 4f3c61

a GCancellable or NULL

rpm-build 4f3c61
 
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61

error

rpm-build 4f3c61

return location for a GError, or NULL

rpm-build 4f3c61
 
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61

Returns

rpm-build 4f3c61

a GInputStream that can be used to

rpm-build 4f3c61
read from the URI pointed to by request
rpm-build 4f3c61
. 

rpm-build 4f3c61

[transfer full]

rpm-build 4f3c61
rpm-build 4f3c61

Since: 2.42

rpm-build 4f3c61
rpm-build 4f3c61

rpm-build 4f3c61
rpm-build 4f3c61

soup_request_send_async ()

rpm-build 4f3c61
void
rpm-build 4f3c61
soup_request_send_async (SoupRequest *request,
rpm-build 4f3c61
                         GCancellable *cancellable,
rpm-build 4f3c61
                         GAsyncReadyCallback callback,
rpm-build 4f3c61
                         gpointer user_data);
rpm-build 4f3c61

Begins an asynchronously request for the URI pointed to by

rpm-build 4f3c61
request
rpm-build 4f3c61
.

rpm-build 4f3c61

Note that you cannot use this method with SoupRequests attached to

rpm-build 4f3c61
a SoupSessionSync.

rpm-build 4f3c61
rpm-build 4f3c61

Parameters

rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61

request

rpm-build 4f3c61

a SoupRequest

rpm-build 4f3c61
 
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61

cancellable

rpm-build 4f3c61

a GCancellable or NULL

rpm-build 4f3c61
 
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61

callback

rpm-build 4f3c61

a GAsyncReadyCallback

rpm-build 4f3c61
 
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61

user_data

rpm-build 4f3c61

user data passed to callback

rpm-build 4f3c61

rpm-build 4f3c61
 
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61

Since: 2.42

rpm-build 4f3c61
rpm-build 4f3c61

rpm-build 4f3c61
rpm-build 4f3c61

soup_request_send_finish ()

rpm-build 4f3c61
GInputStream *
rpm-build 4f3c61
soup_request_send_finish (SoupRequest *request,
rpm-build 4f3c61
                          GAsyncResult *result,
rpm-build 4f3c61
                          GError **error);
rpm-build 4f3c61

Gets the result of a soup_request_send_async().

rpm-build 4f3c61
rpm-build 4f3c61

Parameters

rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61

request

rpm-build 4f3c61

a SoupRequest

rpm-build 4f3c61
 
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61

result

rpm-build 4f3c61

the GAsyncResult

rpm-build 4f3c61
 
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61

error

rpm-build 4f3c61

return location for a GError, or NULL

rpm-build 4f3c61
 
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61

Returns

rpm-build 4f3c61

a GInputStream that can be used to

rpm-build 4f3c61
read from the URI pointed to by request
rpm-build 4f3c61
. 

rpm-build 4f3c61

[transfer full]

rpm-build 4f3c61
rpm-build 4f3c61

Since: 2.42

rpm-build 4f3c61
rpm-build 4f3c61

rpm-build 4f3c61
rpm-build 4f3c61

soup_request_get_content_length ()

rpm-build 4f3c61
goffset
rpm-build 4f3c61
soup_request_get_content_length (SoupRequest *request);
rpm-build 4f3c61

Gets the length of the data represented by request

rpm-build 4f3c61
. For most
rpm-build 4f3c61
request types, this will not be known until after you call
rpm-build 4f3c61
soup_request_send() or soup_request_send_finish().

rpm-build 4f3c61
rpm-build 4f3c61

Parameters

rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61

request

rpm-build 4f3c61

a SoupRequest

rpm-build 4f3c61
 
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61

Returns

rpm-build 4f3c61

the length of the data represented by request

rpm-build 4f3c61
,
rpm-build 4f3c61
or -1 if not known.

rpm-build 4f3c61
rpm-build 4f3c61

Since: 2.42

rpm-build 4f3c61
rpm-build 4f3c61

rpm-build 4f3c61
rpm-build 4f3c61

soup_request_get_content_type ()

rpm-build 4f3c61
const char *
rpm-build 4f3c61
soup_request_get_content_type (SoupRequest *request);
rpm-build 4f3c61

Gets the type of the data represented by request

rpm-build 4f3c61
. For most request
rpm-build 4f3c61
types, this will not be known until after you call
rpm-build 4f3c61
soup_request_send() or soup_request_send_finish().

rpm-build 4f3c61

As in the HTTP Content-Type header, this may include parameters

rpm-build 4f3c61
after the MIME type.

rpm-build 4f3c61
rpm-build 4f3c61

Parameters

rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61

request

rpm-build 4f3c61

a SoupRequest

rpm-build 4f3c61
 
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61

Returns

rpm-build 4f3c61

the type of the data represented by

rpm-build 4f3c61
request
rpm-build 4f3c61
, or NULL if not known. 

rpm-build 4f3c61

[nullable]

rpm-build 4f3c61
rpm-build 4f3c61

Since: 2.42

rpm-build 4f3c61
rpm-build 4f3c61

rpm-build 4f3c61
rpm-build 4f3c61

soup_request_get_session ()

rpm-build 4f3c61
SoupSession *
rpm-build 4f3c61
soup_request_get_session (SoupRequest *request);
rpm-build 4f3c61

Gets request

rpm-build 4f3c61
's SoupSession

rpm-build 4f3c61
rpm-build 4f3c61

Parameters

rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61

request

rpm-build 4f3c61

a SoupRequest

rpm-build 4f3c61
 
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61

Returns

rpm-build 4f3c61

request

rpm-build 4f3c61
's SoupSession. 

rpm-build 4f3c61

[transfer none]

rpm-build 4f3c61
rpm-build 4f3c61

Since: 2.42

rpm-build 4f3c61
rpm-build 4f3c61

rpm-build 4f3c61
rpm-build 4f3c61

soup_request_get_uri ()

rpm-build 4f3c61
SoupURI *
rpm-build 4f3c61
soup_request_get_uri (SoupRequest *request);
rpm-build 4f3c61

Gets request

rpm-build 4f3c61
's URI

rpm-build 4f3c61
rpm-build 4f3c61

Parameters

rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61

request

rpm-build 4f3c61

a SoupRequest

rpm-build 4f3c61
 
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61

Returns

rpm-build 4f3c61

request

rpm-build 4f3c61
's URI. 

rpm-build 4f3c61

[transfer none]

rpm-build 4f3c61
rpm-build 4f3c61

Since: 2.42

rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61

Types and Values

rpm-build 4f3c61
rpm-build 4f3c61

SoupRequest

rpm-build 4f3c61
typedef struct _SoupRequest SoupRequest;
rpm-build 4f3c61

A request to retrieve a particular URI.

rpm-build 4f3c61

Since: 2.42

rpm-build 4f3c61
rpm-build 4f3c61

rpm-build 4f3c61
rpm-build 4f3c61

SOUP_REQUEST_SESSION

rpm-build 4f3c61
#define SOUP_REQUEST_SESSION "session"
rpm-build 4f3c61
rpm-build 4f3c61

Alias for the “session” property, qv.

rpm-build 4f3c61

Since: 2.42

rpm-build 4f3c61
rpm-build 4f3c61

rpm-build 4f3c61
rpm-build 4f3c61

SOUP_REQUEST_URI

rpm-build 4f3c61
#define SOUP_REQUEST_URI     "uri"
rpm-build 4f3c61
rpm-build 4f3c61

Alias for the “uri” property, qv.

rpm-build 4f3c61

Since: 2.42

rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61

Property Details

rpm-build 4f3c61
rpm-build 4f3c61

The “session” property

rpm-build 4f3c61
  “session”                  SoupSession *
rpm-build 4f3c61

The request's SoupSession.

rpm-build 4f3c61

Flags: Read / Write / Construct Only

rpm-build 4f3c61

Since: 2.42

rpm-build 4f3c61
rpm-build 4f3c61

rpm-build 4f3c61
rpm-build 4f3c61

The “uri” property

rpm-build 4f3c61
  “uri”                      SoupURI *
rpm-build 4f3c61

The request URI.

rpm-build 4f3c61

Flags: Read / Write / Construct Only

rpm-build 4f3c61

Since: 2.42

rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61
rpm-build 4f3c61

Generated by GTK-Doc V1.28.1
rpm-build 4f3c61
</body>
rpm-build 4f3c61
</html>