package com_maroontress_libcgi_request

class Pair

#define com_maroontress_libcgi_request_Pair_IMPORT
#include <com/maroontress/libcgi/request/Pair.h>

キーと値のペアです。

Struct Summary

struct Pair
ペア実体となる構造体です。

Method Summary

struct Pair *	Pair_create(void) ペアを生成します。
void	Pair_free(struct Pair * pair) ペアを解放します。
void	Pair_setKey(struct Pair * pair, char * key) キーとなる文字列を設定します。
void	Pair_setValue(struct Pair * pair, char * value) 値となる文字列を設定します。
void	Pair_clear(struct Pair * pair) キーと値を消去します。
char *	Pair_getKey(struct Pair * pair) キーを取得します。
char *	Pair_getValue(struct Pair * pair) 値を取得します。
int	Pair_read(struct Pair * pair, union std_io_InputTube in, struct com_maroontress_libcgi_util_Tub * tub) 入力ストリームinからキーと値のペアを読み込みます。

Struct Detail

struct Pair

ペア実体となる構造体です。

Method Detail

Pair_create

struct Pair * Pair_create(

void)

ペアを生成します。

戻り値が参照するオブジェクトはPair_free()で解放しなければなりません。

Returns:

ペア

Pair_free

void Pair_free(

struct Pair * pair)

ペアを解放します。

pairがNULLの場合はなにもしません。呼び出し後はpairが参照するオブジェクトを参照してはなりません。

設定されていたキーまたは値があればfree(3)で解放されます。

Parameters:

pair - ペア

Pair_setKey

void Pair_setKey(	struct Pair * pair,
	char * key)

キーとなる文字列を設定します。

呼び出し後はkeyが参照するオブジェクトを参照してはなりません。keyはfree(3)で解放可能な文字列でなければなりません。

設定されていたキーがあればfree(3)で解放されます。

Parameters:

pair - ペア
key - キーとなる文字列

Pair_setValue

void Pair_setValue(	struct Pair * pair,
	char * value)

値となる文字列を設定します。

呼び出し後はvalueが参照するオブジェクトを参照してはなりません。valueはfree(3)で解放可能な文字列でなければなりません。

設定されていた値があればfree(3)で解放されます。

Parameters:

pair - ペア
value - 値となる文字列

Pair_clear

void Pair_clear(

struct Pair * pair)

キーと値を消去します。

設定されていたキーまたは値があればfree(3)で解放されます。

Parameters:

pair - ペア

Pair_getKey

char * Pair_getKey(

struct Pair * pair)

キーを取得します。

戻り値が参照するオブジェクトは Pair_clear(), Pair_free(), Pair_read(), Pair_setKey() のいずれかを呼び出すまで有効です。戻り値が参照するオブジェクトを変更、解放してはなりません。

Parameters:

pair - ペア

Returns:

キー

Pair_getValue

char * Pair_getValue(

struct Pair * pair)

値を取得します。

戻り値が参照するオブジェクトは Pair_clear(), Pair_free(), Pair_read(), Pair_setValue() のいずれかを呼び出すまで有効です。戻り値が参照するオブジェクトを変更、解放してはなりません。

Parameters:

pair - ペア

Returns:

値

Pair_read

int Pair_read(	struct Pair * pair,
	union std_io_InputTube in,
	struct com_maroontress_libcgi_util_Tub * tub)

入力ストリームinからキーと値のペアを読み込みます。

inから「キー=値」という形式の文字列を読み込み、pairに設定します。値はURLENCODED形式でエンコードされているとみなします。「&」を読むか、またはストリーム終端を検出するとinの読み込みを終了します。

呼び出し前のpairとtubの内容は捨てられます。

Parameters:

pair - ペア
in - 入力ストリーム
tub - 一時的な作業に使用するタブ

Returns:

読み込みに成功した場合は0、ストリームの終端を検出した場合は1、そうでなければ−1