メインページ | ファイル一覧 | ファイルメンバ

Transport.h

OpenSOAP API トランスポート処理. [詳細]

#include <OpenSOAP/ByteArray.h>
#include <OpenSOAP/Envelope.h>
#include <OpenSOAP/Stream.h>

ソースコードを見る。

マクロ定義

#define OPENSOAP_AUTH_TYPE_BASIC   (1) /* BASIC */
 トランスポートにおけるベーシック認証

#define OPENSOAP_AUTH_TYPE_DIGEST   (2) /* DIGEST */
 トランスポートにおけるダイジェスト認証

#define OPENSOAP_AUTH_TYPE_ANY   (0)
 トランスポートにおける認証でサポートするものなら何でも

#define OPENSOAP_SSL_VER_SSL2   (1) /* SSL_V2.0 ONLY */
 SSL バージョン SSL2.0のみ.

#define OPENSOAP_SSL_VER_SSL3   (2) /* SSL_V3.0 ONLY */
 SSL バージョン SSL3.0のみ.

#define OPENSOAP_SSL_VER_TLS1   (4) /* TLS_V1.0 ONLY */
 SSL バージョン TLS1.0のみ.

#define OPENSOAP_SSL_VER_ALL   (0) /* SSL all version */
 SSL バージョン サポートするもの全て(SSLv2/SSLv3/TLSv1).


型定義

typedef tagOpenSOAPTransport OpenSOAPTransport
 OpenSOAPTransport 構造体型定義.

typedef OpenSOAPTransport * OpenSOAPTransportPtr
 OpenSOAPTransport ポインタ定義.


関数

int OpenSOAPTransportCreate (OpenSOAPTransportPtr *t)
 トランスポートの生成

int OpenSOAPTransportRelease (OpenSOAPTransportPtr t)
 トランスポートの開放

int OpenSOAPTransportSend (OpenSOAPTransportPtr t, OpenSOAPEnvelopePtr soap_env)
 SOAPメッセージをByteArrayとして送信します。.

int OpenSOAPTransportReceive (OpenSOAPTransportPtr t, OpenSOAPEnvelopePtr *soap_env)
 SOAPメッセージ受信.

int OpenSOAPTransportConnect (OpenSOAPTransportPtr t)
 End Point への接続.

int OpenSOAPTransportDisconnect (OpenSOAPTransportPtr t)
 End Point からの切断.

int OpenSOAPTransportInvokeStream (OpenSOAPTransportPtr t, OpenSOAPStreamPtr stream, int input_size, int *tp_status)
int OpenSOAPTransportInvokeByteArray (OpenSOAPTransportPtr t, OpenSOAPByteArrayPtr request, OpenSOAPByteArrayPtr response, int *tp_status)
 OpenSOAPByteArray による SOAP 呼出.

int OpenSOAPTransportInvoke (OpenSOAPTransportPtr t, OpenSOAPEnvelopePtr request, OpenSOAPEnvelopePtr *response)
 SOAP呼出.

int OpenSOAPTransportSetSOAPAction (OpenSOAPTransportPtr t, const char *soap_action)
 SOAP-Action設定(Some-URI).

int OpenSOAPTransportSetURL (OpenSOAPTransportPtr t, const char *url)
 リクエストURL設定

int OpenSOAPTransportSetHeader (OpenSOAPTransportPtr t, const char *header_name, const char *header_value)
 ヘッダー設定

int OpenSOAPTransportGetHeader (OpenSOAPTransportPtr t, const char *header_name, char **header_value)
 レスポンスヘッダーの値の入手

int OpenSOAPTransportSetCharset (OpenSOAPTransportPtr t, const char *charset)
 キャラクタセット設定

int OpenSOAPTransportSetContentType (OpenSOAPTransportPtr t, const char *content_type)
 コンテントタイプ(Content-Type)設定 (OpenSOAPTransportSetCharset()での指定を上書き)

int OpenSOAPTransportSMTPSetHostname (OpenSOAPTransportPtr s)
 SMTPホスト名設定.

int OpenSOAPTransportSMTPSetFrom (OpenSOAPTransportPtr t)
 SMTP送信者設定.

int OpenSOAPTransportSMTPSetTo (OpenSOAPTransportPtr t)
 SMTP宛て先設定.

int OpenSOAPTransportSetAuthUserPass (OpenSOAPTransportPtr t, const char *user, const char *passwd)
 認証用のユーザ／パスワードを設定.

int OpenSOAPTransportSetAuthType (OpenSOAPTransportPtr t, int auth_type)
 認証の方法を設定.

int OpenSOAPTransportSetProxy (OpenSOAPTransportPtr t, const char *host, int port, const char *user, const char *passwd, int auth_type)
 プロキシー・サーバに関する設定

int OpenSOAPTransportSetSSLVersion (OpenSOAPTransportPtr t, int ssl_version)
 許可するSSLバージョンを設定

int OpenSOAPTransportSetSSLCert (OpenSOAPTransportPtr t, const char *ca_file, const char *ca_dir, const char *certchain_file, const char *privkey_file, int verify_level)
 SSL 認証用証明書ファイルの設定.

説明

OpenSOAP API トランスポート処理.

作者:
OpenSOAP Development Team

マクロ定義

#define OPENSOAP_AUTH_TYPE_ANY   (0)
 

トランスポートにおける認証でサポートするものなら何でも

(0)

#define OPENSOAP_AUTH_TYPE_BASIC   (1) /* BASIC */
 

トランスポートにおけるベーシック認証

(1)

#define OPENSOAP_AUTH_TYPE_DIGEST   (2) /* DIGEST */
 

トランスポートにおけるダイジェスト認証

(2)

#define OPENSOAP_SSL_VER_ALL   (0) /* SSL all version */
 

SSL バージョン サポートするもの全て(SSLv2/SSLv3/TLSv1).

(0)

#define OPENSOAP_SSL_VER_SSL2   (1) /* SSL_V2.0 ONLY */
 

SSL バージョン SSL2.0のみ.

(1)

#define OPENSOAP_SSL_VER_SSL3   (2) /* SSL_V3.0 ONLY */
 

SSL バージョン SSL3.0のみ.

(2)

#define OPENSOAP_SSL_VER_TLS1   (4) /* TLS_V1.0 ONLY */
 

SSL バージョン TLS1.0のみ.

(4)

関数

int OpenSOAPTransportConnect (  OpenSOAPTransportPtr  t  ) 
 

End Point への接続.

End Point への接続を行います。

引数:
t OpenSOAPTransportPtr [in] ((|t|)) OpenSOAP トランスポートポインタ
戻り値:
エラーコード

int OpenSOAPTransportCreate (  OpenSOAPTransportPtr *  t  ) 
 

トランスポートの生成

トランスポートを生成します。

引数:
t OpenSOAPTransportPtr * [out] ((|t|)) OpenSOAP トランスポートポインタ
戻り値:
エラーコード

int OpenSOAPTransportDisconnect (  OpenSOAPTransportPtr  t  ) 
 

End Point からの切断.

End Point から切断します。

引数:
t OpenSOAPTransportPtr [in] ((|t|)) OpenSOAP トランスポートポインタ
戻り値:
エラーコード

int OpenSOAPTransportGetHeader (  OpenSOAPTransportPtr  t,
const char *  header_name,
char **  header_value
) 
 

レスポンスヘッダーの値の入手

引数:
t OpenSOAPTransportPtr [in] ((|t|)) OpenSOAP トランスポートポインタ
header_name const char * [in] ((|header_name|)) トランスポートレスポンスヘッダ名
header_value char ** [out] ((|header_value|)) ヘッダ値ポインタ
戻り値:
エラーコード

int OpenSOAPTransportInvoke (  OpenSOAPTransportPtr  t,
OpenSOAPEnvelopePtr  request,
OpenSOAPEnvelopePtr *  response
) 
 

SOAP呼出.

SOAP呼出を行います。返信メッセージをEnveropeポインタに格納します。

引数:
t OpenSOAPTransportPtr [in] ((|t|)) OpenSOAP トランスポートポインタ
request OpenSOAPEnvelopePtr [in] ((|request|)) OpenSOAP 要求
response OpenSOAPEnvelopePtr * [in, out] ((|response|))OpenSOAP レスポンス Envelope ポインタ
戻り値:
エラーコード

int OpenSOAPTransportInvokeByteArray (  OpenSOAPTransportPtr  t,
OpenSOAPByteArrayPtr  request,
OpenSOAPByteArrayPtr  response,
int *  tp_status
) 
 

OpenSOAPByteArray による SOAP 呼出.

OpenSOAPByteArray による SOAP 呼出を行います。

引数:
t OpenSOAPTransportPtr ((|t|)) OpenSOAP トランスポートポインタ
request OpenSOAPEnvelopePtr [in] ((|request|)) OpenSOAP 要求
response OpenSOAPByteArrayPtr [out] ((|response|)) OpenSOAP レスポンス
tp_status int * [out] ((|tp_status|)) トランスポートステータス値ポインタ
戻り値:
エラーコード

int OpenSOAPTransportReceive (  OpenSOAPTransportPtr  t,
OpenSOAPEnvelopePtr *  soap_env
) 
 

SOAPメッセージ受信.

SOAPメッセージの受信を行います。

引数:
t OpenSOAPTransportPtr [in] ((|t|)) OpenSOAP トランスポートポインタ
soap_env OpenSOAPEnvelopePtr * [in, out] ((|soap_env|)) OpenSOAP Envelope ポインタ
戻り値:
エラーコード

int OpenSOAPTransportRelease (  OpenSOAPTransportPtr  t  ) 
 

トランスポートの開放

トランスポートを開放します。

引数:
t OpenSOAPTransportPtr [in] ((|t|)) OpenSOAP トランスポートポインタ
戻り値:
エラーコード

int OpenSOAPTransportSend (  OpenSOAPTransportPtr  t,
OpenSOAPEnvelopePtr  soap_env
) 
 

SOAPメッセージをByteArrayとして送信します。.

引数:
t OpenSOAPTransportPtr [in] ((|t|)) OpenSOAP トランスポートポインタ
soap_env OpenSOAPEnvelopePtr [in] ((|soap_env|)) OpenSOAP Envelope ポインタ
戻り値:
エラーコード

int OpenSOAPTransportSetAuthType (  OpenSOAPTransportPtr  t,
int  auth_type
) 
 

認証の方法を設定.

引数:
t OpenSOAPTransportPtr [in, out] ((|t|)) OpenSOAP トランスポートポインタ
auth_type int [in] ((|auth_type|)) 使用する認証方法 (次のいずれか) OPENSOAP_AUTH_TYPE_BASIC | OPENSOAP_AUTH_TYPE_DIGEST | OPENSOAP_AUTH_TYPE_ANY もし OPENSOAP_AUTH_TYPE_BASICのみが指定された場合、 1回目のリクエストで直接ユーザ・パスワードが送信されます。 (それ以外は、要求された場合のみ)
戻り値:
エラーコード

int OpenSOAPTransportSetAuthUserPass (  OpenSOAPTransportPtr  t,
const char *  user,
const char *  passwd
) 
 

認証用のユーザ／パスワードを設定.

引数:
t OpenSOAPTransportPtr [in, out] ((|t|)) OpenSOAP トランスポートポインタ
user const char * [in] ((|user|)) ユーザ名
passwd const char * [in] ((|passwd|)) パスワード
戻り値:
エラーコード

int OpenSOAPTransportSetCharset (  OpenSOAPTransportPtr  t,
const char *  charset
) 
 

キャラクタセット設定

キャラクタセットを設定します。

引数:
t OpenSOAPTransportPtr [in, out] ((|t|)) OpenSOAP トランスポートポインタ
charset const char * [in] ((|charset|)) キャラクタセットポインタ
戻り値:
エラーコード

int OpenSOAPTransportSetContentType (  OpenSOAPTransportPtr  t,
const char *  content_type
) 
 

コンテントタイプ(Content-Type)設定 (OpenSOAPTransportSetCharset()での指定を上書き)

引数:
t OpenSOAPTransportPtr [in, out] ((|t|)) OpenSOAP トランスポートポインタ
content_type const char * [in] ((|content_type|)) コンテントタイプ
戻り値:
エラーコード

int OpenSOAPTransportSetHeader (  OpenSOAPTransportPtr  t,
const char *  header_name,
const char *  header_value
) 
 

ヘッダー設定

任意のヘッダーを設定します。

引数:
t OpenSOAPTransportPtr [in, out] ((|t|)) OpenSOAP トランスポートポインタ
header_name const char * [in] ((|header_name|)) トランスポートヘッダ名
header_value const char * [in] ((|header_value|)) ヘッダ値ポインタ
戻り値:
エラーコード

int OpenSOAPTransportSetProxy (  OpenSOAPTransportPtr  t,
const char *  host,
int  port,
const char *  user,
const char *  passwd,
int  auth_type
) 
 

プロキシー・サーバに関する設定

引数:
t OpenSOAPTransportPtr [in, out] ((|t|)) OpenSOAP トランスポートポインタ
host const char * [in] ((|host|)) プロキシー・サーバのホスト名
port int [in] ((|port|)) プロキシー・サーバのポート番号
user const char * [in] ((|user|)) プロキシー・サーバ用のユーザ名 (NULLなら認証なし)
passwd const char * [in] ((|passwd|)) プロキシー・サーバ用のパスワード
auth_type int [in] ((|auth_type|)) 使用する認証方法 (次のいずれか) OPENSOAP_AUTH_TYPE_BASIC | OPENSOAP_AUTH_TYPE_DIGEST | OPENSOAP_AUTH_TYPE_ANY
戻り値:
エラーコード

int OpenSOAPTransportSetSOAPAction (  OpenSOAPTransportPtr  t,
const char *  soap_action
) 
 

SOAP-Action設定(Some-URI).

SOAP-Action設定(Some-URI)を行います。

引数:
t OpenSOAPTransportPtr [in, out] ((|t|)) OpenSOAP トランスポートポインタ
soap_action const char * [in] ((|soap_action|)) soap-action ポインタ
戻り値:
エラーコード

int OpenSOAPTransportSetSSLCert (  OpenSOAPTransportPtr  t,
const char *  ca_file,
const char *  ca_dir,
const char *  certchain_file,
const char *  privkey_file,
int  verify_level
) 
 

SSL 認証用証明書ファイルの設定.

引数:
t OpenSOAPTransportPtr [in, out] ((|t|)) OpenSOAP トランスポートポインタ
ca_file const char * [in] ((|ca_file|)) 接続先認証用の認証局の証明書ファイル名 (NULLなら認証なし)
ca_dir const char * [in] ((|ca_dir|)) 認証局の証明書が含まれるディレクトリ名(NULLならディレクトリを見ない)
certchain_file const char * [in] ((|certchain_file|)) ローカルの証明書チェーンファイル名(NULLならローカルの認証なし)
privkey_file const char * [in] ((|privkey_file|)) ローカル認証用証明書のペアとなる秘密鍵のファイル名。(NULLならローカルの認証なし)
verify_level int [in] ((|verify_level|)) 接続先の証明書の確認レベル。
0(デフォルト)ならば証明書が不正でも継続。 1ならば、中断して失敗とする。
戻り値:
Error Code

int OpenSOAPTransportSetSSLVersion (  OpenSOAPTransportPtr  t,
int  ssl_version
) 
 

許可するSSLバージョンを設定

引数:
t OpenSOAPTransportPtr [in, out] ((|t|)) OpenSOAP トランスポートポインタ
ssl_version int [in] ((|ssl_version|)) SSL バージョン。次のいずれか (OPENSOAP_SSL_VER_SSL2 | OPENSOAP_SSL_VER_SSL3 | OPENSOAP_SSL_VER_TLS1 | OPENSOAP_SSL_VER_ALL)
戻り値:
エラーコード

int OpenSOAPTransportSetURL (  OpenSOAPTransportPtr  t,
const char *  url
) 
 

リクエストURL設定

リクエストURL設定

引数:
t OpenSOAPTransportPtr [in, out] ((|t|)) OpenSOAP トランスポートポインタ
url const char * [in] ((|url|)) URL
戻り値:
エラーコード

int OpenSOAPTransportSMTPSetFrom (  OpenSOAPTransportPtr  t  ) 
 

SMTP送信者設定.

SMTP送信者を設定します。

引数:
t OpenSOAPTransportPtr [out] ((|t|)) OpenSOAP トランスポートポインタ
戻り値:
エラーコード

int OpenSOAPTransportSMTPSetHostname (  OpenSOAPTransportPtr  s  ) 
 

SMTPホスト名設定.

SMTPホスト名を設定します。

引数:
s OpenSOAPTransportPtr [out] ((|s|)) OpenSOAP トランスポートポインタ
戻り値:
エラーコード

int OpenSOAPTransportSMTPSetTo (  OpenSOAPTransportPtr  t  ) 
 

SMTP宛て先設定.

SMTP宛て先を設定します。

引数:
t OpenSOAPTransportPtr [out] ((|t|)) OpenSOAP トランスポートポインタ
戻り値:
エラーコード

OpenSOAPに対してMon Oct 18 18:29:48 2004に生成されました。 doxygen 1.3.6