include/anna/comm/DatagramSocket.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_DatagramSocket_hpp
  38 #define anna_comm_DatagramSocket_hpp
  39
  40 #include <anna/comm/ClientSocket.hpp>
  41
  42 namespace anna {
  43
  44 namespace comm {
  45
  46 /**
  47    Esta clase implementa un Socket no orientado a conexion.
  48 */
  49 class DatagramSocket : public ClientSocket {
  50 public:
  51   /**
  52    * Indica el uso que tendrá este DatagramSocket, si para recibir o para enviar.
  53    */
  54   enum Mode { ReadOnly, WriteOnly };
  55
  56   /**
  57      Crear un Socket no orientado a conexion de un sólo sentido.
  58
  59      Los datagram socket definidos como \em Mode \em ReadOnly tienen que ser asociados al
  60      comunicador mediante la invocación al método anna::comm::Communicator::attach.
  61
  62      Los datagram socket definidos como \em Mode \em WriteOnly tienen que invocar a al
  63      método #connect antes de poder ser usados.
  64
  65      \param mode Uso que se dará a este DatagramSocket.
  66      \param address Dirección en la que enviar o recibir mensajes.
  67      \param transportFactory Factoria de protocolos de transporte a usar por este sockets.
  68      \warning La factoria de protocolos debe estar disponible mientras el Socket esta activo.
  69   */
  70   DatagramSocket(const Mode mode, const INetAddress& address, TransportFactory* transportFactory = NULL);
  71
  72   /**
  73      Devuelve el modo en que fue instanciado este Socket.
  74      \return el modo en que fue instanciado este Socket.
  75   */
  76   Mode getMode() const throw() { return a_mode; }
  77
  78   /**
  79      Devuelve \em true si el socket fue instancia como sólo-lectura.
  80      \return \em true si el socket fue instancia como sólo-lectura.
  81   */
  82   const bool isReadOnly() const throw() { return a_mode == ReadOnly; }
  83
  84   /**
  85      Devuelve \em true si el socket fue instancia como sólo-lectura.
  86      \return \em true si el socket fue instancia como sólo-lectura.
  87   */
  88   const bool isWriteOnly() const throw() { return a_mode == WriteOnly; }
  89
  90   /**
  91      Prepara el socket para enviar a la direccion indicada en el constructor.
  92   */
  93   void connect() throw(RuntimeException);
  94
  95 private:
  96   const Mode a_mode;
  97
  98   void do_write(const DataBlock&) throw(RuntimeException);
  99   int do_read(const char* data, const int maxSize) throw(RuntimeException);
 100 };
 101
 102 }
 103 }
 104
 105
 106 #endif
 107
 108
 109