OSRTSocket.h

Go to the documentation of this file.

/*
 * Copyright (c) 1997-2023 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 _OSRTSOCKET_H_
#define _OSRTSOCKET_H_

#ifndef _OS_NOSOCKET

/* Disable MS VC++ Level 4 warning about unreferenced inline functions */
#ifdef _MSC_VER
#pragma warning(disable: 4514)
#endif /* _MSC_VER */

#include "rtxsrc/rtxSocket.h"

class EXTRTCLASS OSRTSocket {
 protected:
   OSRTSOCKET mSocket;  
   int        mInitStatus;
   int        mStatus;
   int        mRetryCount;  
   OSBOOL     mOwner;   

   inline OSBOOL isInitialized () { return mInitStatus == 0; }

 public:
   EXTRTMETHOD OSRTSocket ();

   EXTRTMETHOD OSRTSocket
      (OSRTSOCKET socket, OSBOOL ownership = FALSE, int retryCount = 1);

   EXTRTMETHOD OSRTSocket (const OSRTSocket& socket);

   EXTRTMETHOD ~OSRTSocket ();

   EXTRTMETHOD OSRTSocket* accept (OSIPADDR* destIP = 0, int *port = 0);

   EXTRTMETHOD static const char* addrToString
      (OSIPADDR ipAddr, char* pAddrStr, size_t bufsize);

   EXTRTMETHOD int bind (OSIPADDR addr, int port);

   EXTRTMETHOD int bindUrl (const char* url);

   EXTRTMETHOD int bind (const char* pAddrStr, int port);

   inline int bind (int port) {
      return bind (OSIPADDR_ANY, port);
   }

   EXTRTMETHOD int blockingRead (OSOCTET* pbuf, size_t readBytes);

   EXTRTMETHOD int close ();

   EXTRTMETHOD int connect (const char* host, int port);

   EXTRTMETHOD int connectTimed (const char* host, int port, int nsecs);

   EXTRTMETHOD int connectUrl (const char* url);

   OSBOOL getOwnership () { return mOwner; }

   OSRTSOCKET getSocket () const { return mSocket; }

   inline int getStatus () { return mStatus; }

   EXTRTMETHOD int listen (int maxConnections);

   EXTRTMETHOD int recv (OSOCTET* pbuf, size_t bufsize);

   EXTRTMETHOD int send (const OSOCTET* pdata, size_t size);

   inline void setOwnership (OSBOOL ownership) { mOwner = ownership; }

   inline void setRetryCount (int value) { mRetryCount = value; }

   EXTRTMETHOD static OSIPADDR stringToAddr (const char* pAddrStr);
} ;

#endif /* _OS_NOSOCKET */

#endif //_OSRTSOCKET_H_