Convenience HTTP client API

Convenience HTTP client API — HTTPクライアントとして動作するためのAPI。

Functions

プロパティ

gboolean async Read / Write

オブジェクト階層

GObject
    ╰── SoupCutClient

説明

SoupCutClientオブジェクトはHTTPクライアントとして動作します。SoupCutClientは複数のリクエストやレスポンスを管理することができます。また、SoupCutClientに関連するアサーションのAPIも提供しています。

Functions

soupcut_client_new ()

SoupCutClient *
soupcut_client_new (void);

新たにSoupCutClientオブジェクトを生成して返します。

Returns

SoupCutClientオブジェクト。

Since: 1.0.8


soupcut_client_set_base ()

void
soupcut_client_set_base (SoupCutClient *client,
                         const gchar *uri);

clientのベースURIをuriに設定します。

Parameters

client

SoupCutClientオブジェクト。

 

uri

ベースURIの文字列。

 

Since: 1.0.8


soupcut_client_send_message ()

guint
soupcut_client_send_message (SoupCutClient *client,
                             SoupMessage *message);

clientを使ってmessageを送信します。clientは過去に送信した全てのSoupMessageの情報を保持しています。

Parameters

client

SoupCutClientオブジェクト。

 

message

SoupMessageオブジェクト。

 

Returns

レスポンスのステータスコード。

Since: 1.0.8


soupcut_client_get ()

guint
soupcut_client_get (SoupCutClient *client,
                    const gchar *uri,
                    const gchar *first_query_name,
                    ...);

uriとクエリパラメータで指定されたURIにGETリクエストを送信します。もしもclientのベースURIがsoupcut_client_set_base()によって設定されていた場合は、URIはベースURIとuriを組み合わせたものとなります。そうでない場合は、uriは絶対URIである必要があります。

Parameters

client

SoupCutClientオブジェクト。

 

uri

URI文字列。

 

first_query_name

ひとつめのクエリパラメータの名前

 

...

first_query_nameから始まる、クエリパラメータの名前と値のペア。最後にNULLを指定しなければいけません。

 

Returns

レスポンスのステータスコード。

Since: 1.0.8


soupcut_client_get_n_messages ()

guint
soupcut_client_get_n_messages (SoupCutClient *client);

clientが送信した#SoupMessageの数。

Parameters

client

SoupCutClientオブジェクト。

 

Returns

SoupMessageの数。

Since: 1.0.8


soupcut_client_get_latest_message ()

SoupMessage *
soupcut_client_get_latest_message (SoupCutClient *client);

clientが最後に送信したSoupMessageオブジェクト。

Parameters

client

SoupCutClientオブジェクト。

 

Returns

最後に送信されたSoupMessageオブジェクト。

Since: 1.0.8


soupcut_client_get_async_context ()

GMainContext *
soupcut_client_get_async_context (SoupCutClient *client);

clientの非同期コンテキスト。

Parameters

client

SoupCutClientオブジェクト。

 

Returns

clientGMainContextNULLが返る可能性があります。

Since: 1.0.8

プロパティ詳細

"async"プロパティ

“async”                    gboolean

セッションが非同期の場合は真。

Owner: SoupCutClient

Flags: Read / Write

デフォルト値: FALSE

参考

HTTPクライアント・サーバ用の検証