include/anna/comm/LiteTransport.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_LiteTransport_hpp
  38 #define anna_comm_LiteTransport_hpp
  39
  40 #include <anna/comm/Transport.hpp>
  41 #include <anna/comm/TransportFactory.hpp>
  42 #include <anna/comm/TransportFactoryImpl.hpp>
  43
  44 namespace anna {
  45
  46 namespace comm {
  47
  48 /**
  49   Protocol oriented to internal network messages interchange, supposing no errors in transmision and short-sized
  50   messages which allows length representation in only two bytes. No synchronization mechanisms are provided, then
  51   a single error could cause problems in our process.
  52
  53   @warning Encode mode does not provide enough information to allow re-synchronization in case of error
  54
  55   \see Transport.
  56 */
  57 class LiteTransport : public comm::Transport {
  58 public:
  59   static const int headerSize = sizeof(short int);  /**< Tamao de la cabezera del mensaje */
  60
  61   /**
  62     Destructor.
  63   */
  64   ~LiteTransport();
  65
  66   /**
  67     Returns the class name literal.
  68     @return class name literal.
  69   */
  70   static const char* className() throw() { return "anna::comm::LiteTransport"; }
  71
  72   /**
  73     Returns the transport factory associated to this class
  74     @return transport factory associated to this class
  75   */
  76   static TransportFactory& getFactory() throw() { return st_transportFactory; }
  77
  78 private:
  79   static TransportFactoryImpl <LiteTransport> st_transportFactory;
  80
  81   LiteTransport();
  82
  83   int calculeSize(const DataBlock&) throw(RuntimeException);
  84   const Message* decode(const DataBlock&) throw(RuntimeException);
  85   const DataBlock& code(Message&) throw(RuntimeException);
  86
  87   friend class anna::Allocator <LiteTransport>;
  88 };
  89
  90 }
  91 }
  92 #endif
  93