rtxNetUtil.h

Go to the documentation of this file.

/*
 * Copyright (c) 2003-2020 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 _RTXNETUTIL_H_
#define _RTXNETUTIL_H_

#ifndef _OS_NOSOCKET

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

typedef enum {
   OSRTNetNoProto, OSRTNetHttp, OSRTNetFtp, OSRTNetOtherP
} OSRTNetProtocol ;

typedef enum {
   OSRTNetNoTrans, OSRTNetTCP, OSRTNetUDP, OSRTNetOtherT
} OSRTNetTransport ;

typedef struct OSRTNETURL {
   char*        buffer;         /* mutable URL buffer */
   const char*  domain;
   const char*  path;
   const char*  username;
   const char*  password;
   const char*  authstring; /* Base 64 authentication string */
   int          port;
   OSBOOL       bIsConnect;
} OSRTNETURL;

typedef struct OSRTNETCONN {
   OSCTXT*      pctxt;
   OSRTSOCKET   socket;
   OSRTNETURL   url;
   OSRTNETURL   proxy;
   OSRTNetProtocol protocol;
   OSRTNetTransport transport;
   OSBOOL       dynamic;
} OSRTNETCONN;

#ifdef __cplusplus
extern "C" {
#endif

EXTERNRT OSRTNETCONN* rtxNetCreateConn (OSCTXT* pctxt, const char* url);

EXTERNRT int rtxNetCloseConn (OSRTNETCONN* pNetConn);

EXTERNRT int rtxNetConnect (OSRTNETCONN* pNetConn);

EXTERNRT int rtxNetInitConn
(OSCTXT* pctxt, OSRTNETCONN* pNetConn, const char* url);

EXTERNRT int rtxNetParseURL (OSRTNETCONN* pNetConn, const char* url);

EXTERNRT int rtxNetParseURL2
(OSRTNETCONN* pNetConn, OSRTNETURL* pNetURL, const char* url);

#ifdef __cplusplus
}
#endif

#endif /* _OS_NOSOCKET */

#endif