oaSocket.h

Go to the documentation of this file.

// *****************************************************************************
// oaSocket.h
//
// This file contains the definition for the oaSocket class, and its public
// supporting classes. The oaSocket utility class implements an object for
// managing a TCP stream socket.
//
// The supporting classes include:
//
//  oaSocket
//      This class includes operations and data for using sockets.
//
//  oaClientSocket
//      This class includes operations and data common to client side sockets.
//
//  oaServerSocket
//      This class includes operations and data common to server side sockets.
//
//  oaFDSet
//      This class manages a file descriptor set, which is used for select
//      operations.
//
// *****************************************************************************
// Except as specified in the OpenAccess terms of use of Cadence or Silicon
// Integration Initiative, this material may not be copied, modified,
// re-published, uploaded, executed, or distributed in any way, in any medium,
// in whole or in part, without prior written permission from Cadence.
//
//                Copyright 2002-2005 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaSocket_P)
#define oaSocket_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaString.h"
#if defined(OA_WINDOWS)
#include <WinSock2.h>
#include <Windows.h>
#else
#include <netdb.h>
#include <sys/socket.h>
#include <arpa/inet.h>
#include <sys/param.h>
#include <unistd.h>
#include <dlfcn.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <sys/ipc.h>
#endif

#if defined(HPUX)
#include <dl.h>
#endif

#include <errno.h>



// *****************************************************************************
// Declare and define types in the OpenAccess namespace.
// *****************************************************************************
BEGIN_OA_NAMESPACE



// *****************************************************************************
// Forward Class Declarations
// *****************************************************************************
class oaString;



// *****************************************************************************
// Defines
// *****************************************************************************
#if !defined(OA_WINDOWS)
#define oacHostNameLength       MAXHOSTNAMELEN
#else
#define oacHostNameLength       256
#endif

#define oacInvalidSocket        UINT_MAX
#define oacInvalidSocketAddress UINT_MAX
#define oacSocketError          -1



// *****************************************************************************
// oaSocket
// *****************************************************************************
class OA_BASE_DLL_API oaSocket {
public:
                            oaSocket();
                            ~oaSocket();

    oaBoolean               isOpen() const;
    oaSocketD               getSocketD() const;
    oaUInt4                 getPort() const;

    void                    setAddress(oaUInt4 sockAddr);
    void                    setAddress(const char *address);
    void                    setPort(oaUInt4 port);

    static void             sendMsg(oaSocketD   sd,
                                    oaUInt4     len,
                                    const char  *msg);
    static oaUInt4          recvMsg(oaSocketD   sd,
                                    oaUInt4     len,
                                    char        *msg);
    static void             close(oaSocketD sd);
    static void             getHostName(oaString &hostName);

protected:
    static void             initialize();
    static void             finalize();

    oaSocketD               sd;
    sockaddr_in             addr;

    static const oaUInt4    domain;
    static const oaUInt4    type;
    static const oaUInt4    protocol;
};



// *****************************************************************************
// oaClientSocket
// *****************************************************************************
class OA_BASE_DLL_API oaClientSocket : public oaSocket {
public:
    oaBoolean               connect(const char  *address,
                                    oaUInt4     port);
    oaBoolean               isPortNumAvailable(const char   *address,
                                               oaUInt4      port);
    void                    close();

    static void             setConnectionTimeout(oaUInt4 timeoutVal);
    static oaUInt4          getConnectionTimeout();

private:
    oaBoolean               connectWithTimeout();

    static oaUInt4          s_connectionTimeout;
};



// *****************************************************************************
// oaServerSocket
// *****************************************************************************
class OA_BASE_DLL_API oaServerSocket : public oaSocket {
public:
                            oaServerSocket(oaUInt4 port);

    oaSocketD               accept();
    void                    bind();
    void                    listen();

private:
    static const oaUInt4    listenQ;
};



// *****************************************************************************
// oaFDSet
// *****************************************************************************
class OA_BASE_DLL_API oaFDSet {
public:
                            oaFDSet();

    void                    add(oaUInt4 fd);
    void                    remove(oaUInt4 fd);

    oaUInt4                 getNextReady();
    oaUInt4                 select(oaUInt4 sec);

private:
    fd_set                  fdSet;
    oaUInt4                 maxFD;
    oaUInt4                 minFD;
};



END_OA_NAMESPACE

#endif

Return to top of page

Copyright © 2002 - 2010 Cadence Design Systems, Inc.
All Rights Reserved.