ippSocket.h

Go to the documentation of this file.

// 
// DISCLAIMER: 
//  This software was produced by the National Institute of Standards 
//  and Technology (NIST), an agency of the U.S. government, and by statute is 
//  not subject to copyright in the United States.  Recipients of this 
//  software assume all responsibility associated with its operation,
//  modification,maintenance, and subsequent redistribution. 
//
//  See NIST Administration Manual 4.09.07 b and Appendix I. 
// Socket class header file
#pragma once
#include "ippdme/ippdme.h"

class ippSocketImp;

class IPPDME_EXT_CLASS ippSocket {
 
public:
  
  typedef enum SERROR 
  {
    SOCKET_OK          = 0,
    SOCKET_WOULD_BLOCK = 10035L,
    SOCKET_IS_CONNECTED=10056L,
    SOCKET_CONNECTION_ABORTED,
    SOCKET_OTHER_ERROR = -1,
  };//  socket error

  // --- constructor
  
  ippSocket();
  virtual ~ippSocket();


  bool Create();  

  SERROR  Connect(const char* hostname, int port);

  void Close();


  //  or an error code otherwise
  SERROR Read(char *buffer,int size);

  // or an error code otherwise
  SERROR Write(const char *sendbuf);

  bool Listen(int portNumber);

  // to accept a connection pending client if any.
  // \return WSAEWOULDBLOCK if no client is attempting to connect yet
  // \return 0 if a connection has been extablished
  // in this case the socket passed as  a argument is 
  // initialised and can be used by the server to send /receive
  // data to /from the client.
  // \return\ a socket error otherwise.
  SERROR Accept(ippSocket& socket);

  // probe if the socket is capable of sending data
  // ( useful to detect if the socket is fully connected after a 
  //   call to Connect);
  SERROR CanSendData() ;

  bool IsValid() const;

  SERROR Ping();

  static bool Initialize(); //<! initialize the Win sock layer

protected:
  std::auto_ptr<ippSocketImp> _imp;

private:
  friend class ippSocketImp;
  ippSocket(const ippSocket&);
  void operator=(const ippSocket&);

};

---