-// ANNA - Anna is Not 'N' Anymore
-//
-// (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
-//
-// https://bitbucket.org/testillano/anna
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions
-// are met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-//
-// Authors: eduardo.ramos.testillano@gmail.com
-// cisco.tierra@gmail.com
+// ANNA - Anna is Not Nothingness Anymore //
+// //
+// (c) Copyright 2005-2015 Eduardo Ramos Testillano & Francisco Ruiz Rayo //
+// //
+// See project site at http://redmine.teslayout.com/projects/anna-suite //
+// See accompanying file LICENSE or copy at http://www.teslayout.com/projects/public/anna.LICENSE //
#ifndef anna_comm_Transport_hpp
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;
)
/**
- 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; }