Transport.hpp

Go to the documentation of this file.

// 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
#define anna_comm_Transport_hpp

#include <anna/core/RuntimeException.hpp>
#include <anna/core/DataBlock.hpp>

namespace anna {

namespace comm {

class Communicator;
class Message;

class Transport {

  static const int MinOverQuotaSize = 512;

  int a_overQuotaSize;
  Message* a_inputMessage;

  static Message* nullInputMessage() noexcept(false);

public:
  WHEN_SINGLETHREAD(
    static const int DefaultOverQuotaSize = 2048;
  )
  WHEN_MULTITHREAD(
    static const int DefaultOverQuotaSize = 8192;
  )

  bool enableTimeout() const { return a_enableTimeout; }

  void activateTimeout() { a_enableTimeout = true; }

  void deactivateTimeout() { a_enableTimeout = false; }


  // Internal use: returns associated input message
  Message* getInputMessage() noexcept(false) {
    return (a_inputMessage == NULL) ? nullInputMessage() : a_inputMessage;
  }

  int getOverQuotaSize() const { return a_overQuotaSize; }

  void setOverQuotaSize(const int overQuotaSize) { a_overQuotaSize = (overQuotaSize >= MinOverQuotaSize) ? overQuotaSize : MinOverQuotaSize; }

  virtual int calculeSize(const DataBlock& dataBlock) noexcept(false) = 0;

  virtual const Message* decode(const DataBlock& message) noexcept(false) = 0;

  virtual const DataBlock& code(Message& message) noexcept(false) = 0;

  virtual void clear() { a_forCode.clear(); }

protected:
  DataBlock a_forCode; 
  Transport() :
    a_inputMessage(NULL),
    a_forCode(true),
    a_enableTimeout(false) {
    a_overQuotaSize = DefaultOverQuotaSize;
  }

  void setInputMessage(Message* inputMessage) { a_inputMessage = inputMessage; }

private:

  bool a_enableTimeout;
};

}
}

#endif