rtxSOAP.h

Go to the documentation of this file.

/*
 * Copyright (c) 2003-2022 Objective Systems, Inc.
 *
 * This software is furnished under a license and may be used and copied
 * only in accordance with the terms of such license and with the
 * inclusion of the above copyright notice. This software or any other
 * copies thereof may not be provided or otherwise made available to any
 * other person. No title to and ownership of the software is hereby
 * transferred.
 *
 * The information in this software is subject to change without notice
 * and should not be construed as a commitment by Objective Systems, Inc.
 *
 * PROPRIETARY NOTICE
 *
 * This software is an unpublished work subject to a confidentiality agreement
 * and is protected by copyright and trade secret law.  Unauthorized copying,
 * redistribution or other use of this work is prohibited.
 *
 * The above notice of copyright on this source code product does not indicate
 * any actual or intended publication of such source code.
 *
 *****************************************************************************/
#ifndef _RTXSOAP_H_
#define _RTXSOAP_H_

#include "rtxsrc/rtxCommon.h"
#include "rtxsrc/rtxSocket.h"

#define HTTP_VERSION "1.1"

typedef enum { OSSOAPV1, OSSOAPV2 } OSSoapVersion;

typedef struct OSSOAPCONN {
   OSCTXT*      pctxt;
   OSRTSOCKET   socket;
   OSSoapVersion soapVersion;
   const char*  endpoint;
   char*        host;
   int          port;
   const char*  path;
   const char*  soapAction;
   OSBOOL       keepAlive;
   OSBOOL       chunked;
   OSOCTET      spare[2];  /* maintain word boundary */
   size_t       contentLength;
   int          responseStatusCode; /* status code to send in HTTP response */
   OSUINT32     recvTimeoutSecs;
} OSSOAPCONN;

#ifdef __cplusplus
extern "C" {
#endif

EXTERNRT int rtxSoapInitConn
(OSSOAPCONN* pSoapConn, OSCTXT* pctxt, OSSoapVersion soapv, const char* url);

EXTERNRT int rtxSoapAcceptConn
(OSRTSOCKET listenSocket, OSSOAPCONN* pSoapConn);

EXTERNRT int rtxSoapConnect (OSSOAPCONN* pSoapConn);

EXTERNRT int rtxSoapRecvHttp (OSSOAPCONN* pSoapConn);

EXTERNRT int rtxSoapRecvHttpContent
(OSSOAPCONN* pSoapConn, OSOCTET** ppbuf);

EXTERNRT int rtxSoapRecvHttpLine
(OSSOAPCONN* pSoapConn, char* lbuf, size_t lbufsiz);

EXTERNRT int rtxSoapSendHttpResponse
(OSSOAPCONN* pSoapConn, const OSUTF8CHAR* soapMsg);

EXTERNRT int rtxSoapSendHttp
(OSSOAPCONN* pSoapConn, const OSUTF8CHAR* soapMsg);

EXTERNRT int rtxSoapSetReadTimeout (OSSOAPCONN* pSoapConn, OSUINT32 nsecs);

EXTERNRT int rtxHttpParseHdr
(OSSOAPCONN* pSoapConn, const char* key, const char* value);

/* deprecated. */
EXTERNRT int rtxHttpPost (OSSOAPCONN* pSoapConn, size_t count);

/* deprecated */
EXTERNRT int rtxHttpPostHdr
(OSSOAPCONN* pSoapConn, const char* key, const char* value);

EXTERNRT int rtxHttpTagCmp (const char *s, const char *t);

#ifdef __cplusplus
}
#endif

#endif /* _RTXSOAP_H_ */