include/anna/test/Control.hpp

   1 // ANNA - Anna is Not Nothingness 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_test_Control_hpp
  38 #define anna_test_Control_hpp
  39
  40 #include <anna/core/mt/Mutex.hpp>
  41 #include <anna/core/util/Average.hpp>
  42 #include <anna/core/util/Millisecond.hpp>
  43 #include <anna/core/util/Microsecond.hpp>
  44
  45 namespace anna {
  46    namespace xml {
  47       class Node;
  48    }
  49    namespace comm {
  50       class Communicator;
  51       namespace socket {
  52          class Client;
  53       }
  54    }
  55 }
  56
  57 namespace test {
  58
  59 using namespace anna;
  60
  61 class Control : public Mutex {
  62 public:
  63    Control (comm::Communicator* engine);
  64
  65    void setDelay (const Millisecond delay) throw () { a_delay = delay; }
  66    void setMaxMessage (const int maxMessage) throw () { a_maxMessage = maxMessage; }
  67
  68    int getMaxMessage () const throw () { return a_maxMessage; }
  69
  70    bool canContinue (const comm::socket::Client& clientSocket) throw (RuntimeException);
  71    void delay () throw (RuntimeException);
  72    Millisecond latency (const Millisecond& init) throw (RuntimeException);
  73
  74    void report () throw ();
  75    void stop () throw (RuntimeException);
  76
  77    xml::Node* asXML (xml::Node* parent) throw ();
  78
  79 private:
  80    comm::Communicator& a_engine;
  81    Millisecond a_delay;
  82    Millisecond a_initTime;
  83    int a_maxMessage;
  84    Average <Microsecond> a_avgDelay;
  85    Average <Millisecond> a_avgLatency;
  86 };
  87
  88 }
  89
  90 #endif