al_Socket.hpp

#ifndef INCLUDE_AL_IO_SOCKET_HPP
#define INCLUDE_AL_IO_SOCKET_HPP 1
 
/*  Allocore --
        Multimedia / virtual environment application class library
 
        Copyright (C) 2009. AlloSphere Research Group, Media Arts & Technology,
   UCSB. Copyright (C) 2012. The Regents of the University of California. All
   rights reserved.
 
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are
   met:
 
                Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
 
                Redistributions in binary form must reproduce the above
   copyright notice, this list of conditions and the following disclaimer in the
                documentation and/or other materials provided with the
   distribution.
 
                Neither the name of the University of California nor the names
   of its contributors may be used to endorse or promote products derived from
                this software without specific prior written permission.
 
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
   IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
   EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
   PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
   OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
   WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
   OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
   ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 
        File description:
        Utilties for network socket sending/receiving
 
        File author(s):
        Graham Wakefield, 2010, grrrwaaa@gmail.com
        Lance Putnam, 2010, putnam.lance@gmail.com
*/
 
#include <string>
 
#include "al/system/al_Time.hpp"
#include "al/types/al_ValueSource.hpp"
 
namespace al {
 
class Socket {
public:
  enum {
    // IPv4/v6 protocols
    TCP = 6,    
    UDP = 17,   
    SCTP = 132, 
    // Transmission types
    STREAM = 1 << 8, 
    DGRAM =
        2
        << 8, 
    // Families
    INET = 1 << 16, 
    INET6 = 2 << 16 
  };
 
  Socket();
 
  Socket(uint16_t port, const char *address, al_sec timeout, int type);
 
  virtual ~Socket();
 
  static std::string hostName();
 
  static std::string hostIP();
 
  static std::string nameToIp(std::string name);
 
  bool opened() const;
 
  const std::string &address() const;
 
  uint16_t port() const;
 
  al_sec timeout() const;
 
  bool open(uint16_t port, const char *address, al_sec timeout, int type);
 
  void close();
 
  bool bind();
 
 
  bool connect();
 
 
  void timeout(al_sec t);
 
 
  //
  size_t recv(char *buffer, size_t maxlen, char *from = nullptr);
 
 
  size_t send(const char *buffer, size_t len);
 
 
  bool listen();
 
 
  bool accept(Socket &sock);
 
  ValueSource *valueSource();
 
protected:
  // Called after a successful call to open
  virtual bool onOpen() { return true; }
 
private:
  struct Impl;
  Impl *mImpl;
  ValueSource mValueSource;
};
 
 
class SocketClient : public Socket {
public:
  SocketClient() {}
 
  SocketClient(uint16_t port, const char *address = "localhost",
               al_sec timeout = 0, int type = UDP | DGRAM)
      : Socket(port, address, timeout, type) {
    SocketClient::onOpen();
  }
 
protected:
  virtual bool onOpen();
};
 
 
class SocketServer : public Socket {
public:
  SocketServer() {}
 
  SocketServer(uint16_t port, const char *address = "", al_sec timeout = 0,
               int type = UDP | DGRAM)
      : Socket(port, address, timeout, type) {
    SocketServer::onOpen();
  }
 
protected:
  virtual bool onOpen();
};
 
// typedef SocketClient SocketSend;
 
// typedef SocketServer SocketRecv;
 
} // namespace al
 
#endif /* include guard */