Transport.h File Reference

OpenSOAP API Transport Processing. More...

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

Go to the source code of this file.

Defines
#define	OPENSOAP_AUTH_TYPE_BASIC   (1) /* BASIC */
	Transport Basic Authentication.
#define	OPENSOAP_AUTH_TYPE_DIGEST   (2) /* DIGEST */
	Transport Digest Authentification.
#define	OPENSOAP_AUTH_TYPE_ANY   (0)
	Any supported type for Transport Authentification.
#define	OPENSOAP_SSL_VER_SSL2   (1) /* SSL_V2.0 ONLY */
	Transport SSL Version SSL2.0 ONLY.
#define	OPENSOAP_SSL_VER_SSL3   (2) /* SSL_V3.0 ONLY */
	Transport SSL Version SSL3.0 ONLY.
#define	OPENSOAP_SSL_VER_TLS1   (4) /* TLS_V1.0 ONLY */
	Transport SSL Version TLS1.0 ONLY.
#define	OPENSOAP_SSL_VER_ALL   (0) /* SSL all version */
	Transport SSL Version accepts all Support Version (SSLv2/SSLv3/TLSv1).
Typedefs
typedef tagOpenSOAPTransport	OpenSOAPTransport
	OpenSOAPTransport Structure Type Definition.
typedef OpenSOAPTransport *	OpenSOAPTransportPtr
	OpenSOAPTransport Pointer Type Definition.
Functions
int	OpenSOAPTransportCreate (OpenSOAPTransportPtr *t)
	Create Transport instance.
int	OpenSOAPTransportRelease (OpenSOAPTransportPtr t)
	Release OpenSOAP Transport.
int	OpenSOAPTransportSend (OpenSOAPTransportPtr t, OpenSOAPEnvelopePtr soap_env)
	Send SOAP Envelope as ByteArray.
int	OpenSOAPTransportReceive (OpenSOAPTransportPtr t, OpenSOAPEnvelopePtr *soap_env)
	Receive SOAP Message.
int	OpenSOAPTransportConnect (OpenSOAPTransportPtr t)
	Connect to end point.
int	OpenSOAPTransportDisconnect (OpenSOAPTransportPtr t)
	Disconnect from 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)
	SOAP Service call using OpenSOAPByteArray.
int	OpenSOAPTransportInvoke (OpenSOAPTransportPtr t, OpenSOAPEnvelopePtr request, OpenSOAPEnvelopePtr *response)
	SOAP call.
int	OpenSOAPTransportSetSOAPAction (OpenSOAPTransportPtr t, const char *soap_action)
	Set SOAP-Action Header (Some-URI).
int	OpenSOAPTransportSetURL (OpenSOAPTransportPtr t, const char *url)
	Set request URL.
int	OpenSOAPTransportSetHeader (OpenSOAPTransportPtr t, const char *header_name, const char *header_value)
	Set Header.
int	OpenSOAPTransportGetHeader (OpenSOAPTransportPtr t, const char *header_name, char **header_value)
	Get a header value of the response.
int	OpenSOAPTransportSetCharset (OpenSOAPTransportPtr t, const char *charset)
	Set Character Set.
int	OpenSOAPTransportSetContentType (OpenSOAPTransportPtr t, const char *content_type)
	Set Content-Type (Overwrite OpenSOAPTransportSetCharset()).
int	OpenSOAPTransportSMTPSetHostname (OpenSOAPTransportPtr s)
	Set SMTP Host.
int	OpenSOAPTransportSMTPSetFrom (OpenSOAPTransportPtr t)
	Set SMTP From Header.
int	OpenSOAPTransportSMTPSetTo (OpenSOAPTransportPtr t)
	Set SMTP To Header.
int	OpenSOAPTransportSetAuthUserPass (OpenSOAPTransportPtr t, const char *user, const char *passwd)
	Set User/Passwd for Authentification.
int	OpenSOAPTransportSetAuthType (OpenSOAPTransportPtr t, int auth_type)
	Set Authentification type.
int	OpenSOAPTransportSetProxy (OpenSOAPTransportPtr t, const char *host, int port, const char *user, const char *passwd, int auth_type)
	Set Proxy Server Information.
int	OpenSOAPTransportSetSSLVersion (OpenSOAPTransportPtr t, int ssl_version)
	Set acceptable SSL versions.
int	OpenSOAPTransportSetSSLCert (OpenSOAPTransportPtr t, const char *ca_file, const char *ca_dir, const char *certchain_file, const char *privkey_file, int verify_level)
	Set SSL Certification files.

---

Detailed Description

OpenSOAP API Transport Processing.

Author:

OpenSOAP Development Team

---

Define Documentation

#define OPENSOAP_AUTH_TYPE_ANY   (0)

Any supported type for Transport Authentification. (0)

#define OPENSOAP_AUTH_TYPE_BASIC   (1) /* BASIC */

Transport Basic Authentication. (1)

#define OPENSOAP_AUTH_TYPE_DIGEST   (2) /* DIGEST */

Transport Digest Authentification. (2)

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

Transport SSL Version accepts all Support Version (SSLv2/SSLv3/TLSv1). (0)

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

Transport SSL Version SSL2.0 ONLY. (1)

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

Transport SSL Version SSL3.0 ONLY. (2)

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

Transport SSL Version TLS1.0 ONLY. (4)

---

Function Documentation

int OpenSOAPTransportConnect (  OpenSOAPTransportPtr  t  )

Connect to end point. Parameters: t  OpenSOAPTransportPtr [in] ((|t|)) OpenSOAP Transport pointer Returns: Error Code

int OpenSOAPTransportCreate (  OpenSOAPTransportPtr *  t  )

Create Transport instance. Parameters: t  OpenSOAPTransportPtr * [out] ((|t|)) OpenSOAP Transport pointer Returns: Error Code

int OpenSOAPTransportDisconnect (  OpenSOAPTransportPtr  t  )

Disconnect from end point. Parameters: t  OpenSOAPTransportPtr [in] ((|t|)) OpenSOAP Transport pointer Returns: Error Code

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

Get a header value of the response. Parameters: t  OpenSOAPTransportPtr [in] ((|t|)) OpenSOAP Transport pointer header_name  const char * [in] ((|header_name|)) header name header_value  char ** [out] ((|header_value|)) header's value Returns: Error Code

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

SOAP call. Parameters: t  OpenSOAPTransportPtr [in] ((|t|)) OpenSOAP Transport pointer request  OpenSOAPEnvelopePtr [in] ((|request|)) SOAP request Envelope response  OpenSOAPEnvelopePtr * [in, out] ((|response|)) SOAP response Envelope Returns: Error Code OPENSOAP_TRANSPORT_ERROR (getaddrinfo) OPENSOAP_TRANSPORT_HOST_NOT_FOUND Hostname not found (DNS error) (connect) OPENSOAP_TRANSPORT_NETWORK_UNREACH Network is unreachable (Network problem on local?) OPENSOAP_TRANSPORT_HOST_UNREACH Hostname is unreachable (Network problem on remote?) OPENSOAP_TRANSPORT_CONNECTION_REFUSED Connection Refused (The daemon doesn't exist) OPENSOAP_TRANSPORT_CONNECTION_TIMEOUT Connection Timed out (The server may be busy) HTTP OPENSOAP_TRANSPORT_IS_HTTP_ERROR() OPENSOAP_TRANSPORT_GET_HTTP_ERROR() OPENSOAP_UNSUPPORT_PROTOCOL

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

SOAP Service call using OpenSOAPByteArray. Parameters: t  OpenSOAPTransportPtr ((|t|)) OpenSOAP Transport pointer request  OpenSOAPEnvelopePtr [in] ((|request|)) SOAP request data response  OpenSOAPByteArrayPtr [out] ((|response|)) SOAP response data tp_status  int * [out] ((|tp_status|)) Transport status value Returns: Error Code

int OpenSOAPTransportReceive (  OpenSOAPTransportPtr  t, OpenSOAPEnvelopePtr *  soap_env )

Receive SOAP Message. Parameters: t  OpenSOAPTransportPtr [in] ((|t|)) OpenSOAP Transport pointer soap_env  OpenSOAPEnvelopePtr * [in, out] ((|soap_env|)) SOAP Envelope Returns: Error Code

int OpenSOAPTransportRelease (  OpenSOAPTransportPtr  t  )

Release OpenSOAP Transport. Parameters: t  OpenSOAPTransportPtr [in] ((|t|)) OpenSOAP Transport pointer Returns: Error Code

int OpenSOAPTransportSend (  OpenSOAPTransportPtr  t, OpenSOAPEnvelopePtr  soap_env )

Send SOAP Envelope as ByteArray. Parameters: t  OpenSOAPTransportPtr [in] ((|t|)) OpenSOAP Transport pointer soap_env  OpenSOAPEnvelopePtr [in] ((|soap_env|)) SOAP Envelope Returns: Error Code

int OpenSOAPTransportSetAuthType (  OpenSOAPTransportPtr  t, int  auth_type )

Set Authentification type. Parameters: t  OpenSOAPTransportPtr [in, out] ((|t|)) OpenSOAP Transport pointer auth_type  int [in] ((|auth_type|)) acceptable type for authentication in choice of OPENSOAP_AUTH_TYPE_BASIC | OPENSOAP_AUTH_TYPE_DIGEST | OPENSOAP_AUTH_TYPE_ANY If only OPENSOAP_AUTH_TYPE_BASIC is set, directly send UserPassword for Basic Authentication in first request. Returns: Error Code

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

Set User/Passwd for Authentification. Parameters: t  OpenSOAPTransportPtr [in, out] ((|t|)) OpenSOAP Transport pointer user  const char * [in] ((|user|)) username for authentication passwd  const char * [in] ((|passwd|)) password for authentication Returns: Error Code

int OpenSOAPTransportSetCharset (  OpenSOAPTransportPtr  t, const char *  charset )

Set Character Set. Parameters: t  OpenSOAPTransportPtr [in, out] ((|t|)) OpenSOAP Transport pointer charset  const char * [in] ((|charset|)) character set Returns: Error Code

int OpenSOAPTransportSetContentType (  OpenSOAPTransportPtr  t, const char *  content_type )

Set Content-Type (Overwrite OpenSOAPTransportSetCharset()). Parameters: t  OpenSOAPTransportPtr [in, out] ((|t|)) OpenSOAP Transport pointer content_type  const char * [in] ((|content_type|)) content type Returns: Error Code

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

Set Header. Parameters: t  OpenSOAPTransportPtr [in, out] ((|t|)) OpenSOAP Transport pointer header_name  const char * [in] ((|header_name|)) header name header_value  const char * [in] ((|header_value|)) header's value Returns: Error Code

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

Set Proxy Server Information. Parameters: t  OpenSOAPTransportPtr [in, out] ((|t|)) OpenSOAP Transport pointer host  const char * [in] ((|host|)) Hostname of Proxy Server port  int [in] ((|port|)) Port Number of Proxy Server user  const char * [in] ((|user|)) Proxy Server username (NULL for non-user/passwd auth) passwd  const char * [in] ((|passwd|)) Proxy Server passwd auth_type  int [in] ((|auth_type|)) acceptable type for authentication in choice of OPENSOAP_AUTH_TYPE_BASIC | OPENSOAP_AUTH_TYPE_DIGEST | OPENSOAP_AUTH_TYPE_ANY Returns: Error Code

int OpenSOAPTransportSetSOAPAction (  OpenSOAPTransportPtr  t, const char *  soap_action )

Set SOAP-Action Header (Some-URI). Parameters: t  OpenSOAPTransportPtr [in, out] ((|t|)) OpenSOAP Transport pointer soap_action  const char * [in] ((|soap_action|)) soap-action Returns: Error Code

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

Set SSL Certification files. Parameters: t  OpenSOAPTransportPtr [in, out] ((|t|)) OpenSOAP Transport pointer ca_file  const char * [in] ((|ca_file|)) filename of Certification Authority for Peer (NULL for no certification) ca_dir  const char * [in] ((|ca_dir|)) directory name which contains Peer's CA keys (if NULL, look up no directory) certchain_file  const char * [in] ((|certchain_file|)) filename of SSL Certification Chains for local (NULL for no certification) privkey_file  const char * [in] ((|privkey_file|)) filename of Private Key, which is a pair of certchain_file (NULL for no certification) verify_level  int [in] ((|verify_level|)) Verification Level of Peer Certification 0(default) = session continues even if the certification is invalid, 1 = quit and returns as failed Returns: Error Code

int OpenSOAPTransportSetSSLVersion (  OpenSOAPTransportPtr  t, int  ssl_version )

Set acceptable SSL versions. Parameters: t  OpenSOAPTransportPtr [in, out] ((|t|)) OpenSOAP Transport pointer ssl_version  int [in] ((|ssl_version|)) SSL version choice from (OPENSOAP_SSL_VER_SSL2 | OPENSOAP_SSL_VER_SSL3 | OPENSOAP_SSL_VER_TLS1 | OPENSOAP_SSL_VER_ALL) Returns: Error Code

int OpenSOAPTransportSetURL (  OpenSOAPTransportPtr  t, const char *  url )

Set request URL. Parameters: t  OpenSOAPTransportPtr [in, out] ((|t|)) OpenSOAP Transport pointer url  const char * [in] ((|url|)) URL Returns: Error Code

int OpenSOAPTransportSMTPSetFrom (  OpenSOAPTransportPtr  t  )

Set SMTP From Header. Parameters: t  OpenSOAPTransportPtr [out] ((|t|)) OpenSOAP Transport pointer Returns: Error Code

int OpenSOAPTransportSMTPSetHostname (  OpenSOAPTransportPtr  s  )

Set SMTP Host. Parameters: s  OpenSOAPTransportPtr [out] ((|s|)) OpenSOAP Transport pointer Returns: Error Code

int OpenSOAPTransportSMTPSetTo (  OpenSOAPTransportPtr  t  )

Set SMTP To Header. Parameters: t  OpenSOAPTransportPtr [out] ((|t|)) OpenSOAP Transport pointer Returns: Error Code

---