Environment redesign and test/examples review. English API revisions

[anna.git] / include / anna / comm / Transport.hpp

diff --git a/include/anna/comm/Transport.hpp b/include/anna/comm/Transport.hpp
index 5c06baf..d4d5a29 100644 (file)
--- a/include/anna/comm/Transport.hpp
+++ b/include/anna/comm/Transport.hpp
@@ -72,8 +72,8 @@ class Message;
 class Transport {
 public:
   /**
-     Numero de bytes maximo que puede mantener cada ClientSocket sin identificar
-     un mensaje propio del protocolo.
+    Maximum number of bytes kept by each ClientSocket without identifying
+    a message for the own protocol.
   */
   WHEN_SINGLETHREAD(
     static const int DefaultOverQuotaSize = 2048;
@@ -83,38 +83,33 @@ public:
   )
 
   /**
-     Devuelve \em true si la capa de transporte tiene activado el sistema de control
-     de temporizacion.
+    Returns true if the transport layer has a timming control system activated.
   */
   bool enableTimeout() const throw() { return a_enableTimeout; }
 
   /**
-     Activa el control de temporización para los ClientSocket que fueron creados
-     usando esta capa de transporte. Los ClientSocket creados usando esta capa
-     de transporte se cerraran automaticamente si no se detecta actividad en
-     un determinado periodo de tiempo.
-     \see Communicator::setTimeout.
+    Activates the timming control system for the ClientSocket which were created
+    through this transport layer. They will be automatically closed if no activity
+    is detected in a time interval.
+    \see Communicator::setTimeout.
   */
   void activateTimeout() throw() { a_enableTimeout = true; }
 
   /**
-     Activa el control de temporizacion para los ClientSocket que fueron creados
-     usando esta capa de transporte.
+    Deactivates the timming control system for the ClientSocket which were created
+    through this transport layer.
   */
   void deactivateTimeout() throw() { a_enableTimeout = false; }
 
-  /**
-     Devuelve el mensaje de entrada asociado.
-     \return La instancia del mensaje de entrada asociado.
-     \warning Exclusivamente de uso interno.
-  */
+
+  // Internal use: returns associated input message
   Message* getInputMessage() throw(RuntimeException) {
     return (a_inputMessage == NULL) ? nullInputMessage() : a_inputMessage;
   }
 
   /**
-     Devuevel el numero bytes que reserva este protocolo para el buffer de memoria intermedia.
-     \return el numero bytes que reserva este protocolo para el buffer de memoria intermedia.
+    Returns the number of bytes reserved by this protocol for the intermediate buffer.
+    @return number of bytes reserved by this protocol for the intermediate buffer.
   */
   int getOverQuotaSize() const throw() { return a_overQuotaSize; }