include/anna/comm/AccessPoint.hpp

   1 // ANNA - Anna is Not 'N' Anymore
   2 //
   3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
   4 //
   5 // https://bitbucket.org/testillano/anna
   6 //
   7 // Redistribution and use in source and binary forms, with or without
   8 // modification, are permitted provided that the following conditions
   9 // are met:
  10 //
  11 //     * Redistributions of source code must retain the above copyright
  12 // notice, this list of conditions and the following disclaimer.
  13 //     * Redistributions in binary form must reproduce the above
  14 // copyright notice, this list of conditions and the following disclaimer
  15 // in the documentation and/or other materials provided with the
  16 // distribution.
  17 //     * Neither the name of Google Inc. nor the names of its
  18 // contributors may be used to endorse or promote products derived from
  19 // this software without specific prior written permission.
  20 //
  21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32 //
  33 // Authors: eduardo.ramos.testillano@gmail.com
  34 //          cisco.tierra@gmail.com
  35
  36
  37 #ifndef anna_comm_AccessPoint_hpp
  38 #define anna_comm_AccessPoint_hpp
  39
  40 #include <sys/un.h>
  41
  42 #include <anna/core/RuntimeException.hpp>
  43
  44 #include <anna/comm/INetAddress.hpp>
  45
  46 namespace anna {
  47
  48 namespace xml {
  49 class Node;
  50 }
  51
  52 namespace comm {
  53
  54 class Socket;
  55
  56 /**
  57    Estructura para mantener la informacion de los extremos de un Socket.
  58
  59    Dependiendo del tipo de Socket puede tener un punto local y/o un punto
  60    remoto.
  61
  62    \see Socket
  63    \warning This should be internally used
  64 */
  65 class AccessPoint {
  66 public:
  67   AccessPoint() : a_path(NULL) {;}
  68   AccessPoint(const std::string& path) : a_path(new std::string(path)) {;}
  69   AccessPoint(const INetAddress& inetAddress) : a_path(NULL), a_inetAddress(inetAddress) {;}
  70
  71   ~AccessPoint() { delete a_path;  }
  72
  73   const INetAddress& getINetAddress() const throw() { return a_inetAddress; }
  74   const std::string& getPath() const throw() { return *a_path; }
  75
  76   void clear() throw() { a_inetAddress.clear(); delete a_path; a_path = NULL; }
  77   bool isNull() const throw() { return a_path == NULL && a_inetAddress.isNull(); }
  78
  79   bool operator == (const AccessPoint&) const throw();
  80   AccessPoint& operator = (const INetAddress&) throw();
  81   AccessPoint& operator = (const std::string& path) throw();
  82   AccessPoint& operator = (const AccessPoint&) throw();
  83
  84   void asString(std::string& msg) const throw();
  85
  86   void asXML(const char* name, xml::Node* parent) const throw(RuntimeException);
  87
  88   std::string serialize() const throw();
  89
  90   void translate(const Socket&, sockaddr*&, int& len) throw(RuntimeException);
  91
  92 private:
  93   const Socket* a_owner;
  94   INetAddress a_inetAddress;
  95   std::string* a_path;
  96   sockaddr_in a_sockaddr_in;
  97   sockaddr_un a_sockaddr_un;
  98 };
  99
 100 }
 101 }
 102
 103 #endif
 104