Main Page   File List   File Members  

ClientSocket.h File Reference

OpenSOAP API Client Socket Processing. More...

#include <OpenSOAP/ByteArray.h>

Go to the source code of this file.

Typedefs

typedef tagOpenSOAPClientSocket OpenSOAPClientSocket
 OpenSOAPClientSocket Structure Type Definition.

typedef OpenSOAPClientSocketOpenSOAPClientSocketPtr
 OpenSOAPClientSocket Pointer Type Definition.


Functions

int OpenSOAPClientSocketCreate (OpenSOAPClientSocketPtr *s)
 OpenSOAP ClientSocket instance create. More...

int OpenSOAPClientSocketRelease (OpenSOAPClientSocketPtr s)
 Release OpenSOAP ClientSocket. More...

int OpenSOAPClientSocketOpen (OpenSOAPClientSocketPtr s, const char *node, const char *service)
 Open and Connect OpenSOAP ClientSocket. More...

int OpenSOAPClientSocketClose (OpenSOAPClientSocketPtr s)
 Close OpenSOAP ClientSocket. More...

int OpenSOAPClientSocketRead (OpenSOAPClientSocketPtr s, unsigned char *buf, size_t *buf_sz)
 Read from OpenSOAP ClientSocket. More...

int OpenSOAPClientSocketWrite (OpenSOAPClientSocketPtr s, const unsigned char *buf, size_t *buf_sz)
 Write to OpenSOAP ClientSocket. More...

int OpenSOAPClientSocketReadToDelm (OpenSOAPClientSocketPtr s, const unsigned char *delm, size_t delm_sz, OpenSOAPByteArrayPtr buf)
 Read up to delimiter from OpenSOAP ClientSocket. More...


Detailed Description

OpenSOAP API Client Socket Processing.

Author:
OpenSOAP Development Team

Function Documentation

int OpenSOAPClientSocketClose OpenSOAPClientSocketPtr    s
 

Close OpenSOAP ClientSocket.

Parameters:
s  OpenSOAPClientSocketPtr [in] ((|s|)) OpenSOAP ClientSocket
Returns:
Error Code

int OpenSOAPClientSocketCreate OpenSOAPClientSocketPtr   s
 

OpenSOAP ClientSocket instance create.

Parameters:
s  OpenSOAPClientSocketPtr * [out] ((|s|)) OpenSOAP ClientSocket pointer
Returns:
Error Code

int OpenSOAPClientSocketOpen OpenSOAPClientSocketPtr    s,
const char *    node,
const char *    service
 

Open and Connect OpenSOAP ClientSocket.

Parameters:
s  OpenSOAPClientSocketPtr [in] ((|s|)) OpenSOAP ClientSocket
node  const char * [in] ((|node|)) hostname, and so on node. (i.e. "www.isrc.co.jp", "192.168.0.1", ...)
service  const char * [in] ((|service|)) service. (i.e. "http", "ftp", "smtp", "8080", ...)
Returns:
Error Code

int OpenSOAPClientSocketRead OpenSOAPClientSocketPtr    s,
unsigned char *    buf,
size_t *    buf_sz
 

Read from OpenSOAP ClientSocket.

Parameters:
s  OpenSOAPClientSocketPtr [in] ((|s|)) OpenSOAP ClientSocket
buf  unsigned char * [in] ((|buf|)) buffer for read data
buf_sz  size_t * [in, out] ((|buf_sz|)) Size of buffer. After this function call, returns actual size read.
Returns:
Error Code

int OpenSOAPClientSocketReadToDelm OpenSOAPClientSocketPtr    s,
const unsigned char *    delm,
size_t    delm_sz,
OpenSOAPByteArrayPtr    buf
 

Read up to delimiter from OpenSOAP ClientSocket.

Parameters:
s  OpenSOAPClientSocketPtr [in] ((|s|)) OpenSOAP ClientSocket
delm  const unsigned char * [in] ((|delm|)) Delimiter data array
delm_sz  size_t [in] ((|delm_sz|)) Delimiter data size
buf  OpenSOAPByteArrayPtr [out] ((|buf|)) Buffer for read data
Returns:
Error Code

int OpenSOAPClientSocketRelease OpenSOAPClientSocketPtr    s
 

Release OpenSOAP ClientSocket.

Parameters:
s  OpenSOAPClientSocketPtr [in] ((|s|)) OpenSOAP ClientSocket
Returns:
Error Code

int OpenSOAPClientSocketWrite OpenSOAPClientSocketPtr    s,
const unsigned char *    buf,
size_t *    buf_sz
 

Write to OpenSOAP ClientSocket.

Parameters:
s  OpenSOAPClientSocketPtr [in] ((|s|)) OpenSOAP ClientSocket
buf  const unsigned char * [in] ((|buf|)) buffer for write data
buf_sz  size_t * ((|buf_sz|)) Size of buffer. After this function call, return write size.
Returns:
Error Code


Generated on Sat Feb 1 20:46:40 2003 for OpenSOAP by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002