include/anna/comm/functions.hpp

   1 // ANNA - Anna is Not Nothingness 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_functions_hpp
  38 #define anna_comm_functions_hpp
  39
  40 #include <vector>
  41
  42 #include <anna/app/functions.hpp>
  43
  44 namespace anna {
  45
  46 namespace comm {
  47
  48 class Application;
  49 class Server;
  50 class Service;
  51
  52 /**
  53    functions - Methods and variables
  54 */
  55 struct functions : public anna::app::functions {
  56   /**
  57      Returns the host name over which we are executing our process.
  58      @return host name over which we are executing our process.
  59   */
  60   static std::string getHostName() throw(RuntimeException);
  61
  62
  63   /**
  64      Resolves the host name provided with the first IP returned by the system.
  65      Aliases and their addresses are traced as well as the official host name.
  66
  67      @param hostname Logical name for the server used to resolve (could be www.gopher.net i.e.).
  68
  69      @return First IP address returned by the system.
  70
  71      \see man gethostbyname.
  72    */
  73   static std::string resolveIP(const char* hostname) throw(RuntimeException);
  74
  75   /**
  76      Returns our application instance on anna.comm layer.
  77      @return Reference to our application instance on anna.comm layer.
  78   */
  79   static comm::Application& getApp() throw(RuntimeException);
  80 };
  81
  82 }
  83 }
  84
  85 #endif
  86
  87