octopi/library/tests_sockets/spocket_tester.h

   1 #ifndef TEST_CROMP_CLASS
   2 #define TEST_CROMP_CLASS
   3
   4 /*****************************************************************************\
   5 *                                                                             *
   6 *  Name   : spocket_tester                                                    *
   7 *  Author : Chris Koeritz                                                     *
   8 *                                                                             *
   9 *  Purpose:                                                                   *
  10 *                                                                             *
  11 *    Puts the spocket class through some test paces.                          *
  12 *                                                                             *
  13 *******************************************************************************
  14 * Copyright (c) 2000-$now By Author.  This program is free software; you can  *
  15 * redistribute it and/or modify it under the terms of the GNU General Public  *
  16 * License as published by the Free Software Foundation; either version 2 of   *
  17 * the License or (at your option) any later version.  This is online at:      *
  18 *     http://www.fsf.org/copyleft/gpl.html                                    *
  19 * Please send any updates to: fred@gruntose.com                               *
  20 \*****************************************************************************/
  21
  22 #include <sockets/internet_address.h>
  23 #include <sockets/spocket.h>
  24 #include <sockets/tcpip_stack.h>
  25
  26 // this structure is filled by the tester during a send data call.
  27 class testing_statistics
  28 {
  29 public:
  30   int total_runs;       // how many cycles did we successfully do?
  31   int bytes_sent;       // overall count of bytes sent.
  32   int bytes_received;   // overall count of bytes received.
  33   int send_time;        // time taken just to invoke "send" function.
  34   int receive_time;     // time taken just to invoke "recv" function.
  35   int round_trip_time;  // time taken between sending and receiving back.
  36
  37   testing_statistics()
  38       : total_runs(0), bytes_sent(0), bytes_received(0), send_time(0),
  39         receive_time(0), round_trip_time(0) {}
  40 };
  41
  42 // our main tester class.
  43 class spocket_tester
  44 {
  45 public:
  46   spocket_tester(const sockets::internet_address &where);
  47     // constructs the tester object.  "where" provides information about either
  48     // this side (for a server) or the other side (for a client).
  49
  50   ~spocket_tester();
  51     // destroys the tester object.
  52
  53   bool connect();
  54     // acts as a client and connects to a destination.
  55
  56   bool accept(bool wait = true);
  57     // acts as a server and accepts a connection from a client.
  58
  59   bool do_a_send(basis::abyte *buffer, int size, testing_statistics &stats);
  60
  61   bool do_a_receive(int size_expected, testing_statistics &stats);
  62
  63   bool perform_test(int size, int count, testing_statistics &stats_to_fill);
  64     // sends "count" random data chunks of the "size" specified.  the measured
  65     // performance during this sending is reported in "stats_to_fill".
  66
  67 private:
  68   sockets::internet_address *_where;  // our communications endpoint.
  69   sockets::tcpip_stack *_stack;  // provides access to the operating system layers.
  70   sockets::spocket *_socket;  // does the communication for us.
  71   sockets::spocket *_root_server;  // used for server side testing.
  72   sockets::raw_socket *_raw;  // provides functions on sockets.
  73 };
  74
  75 #endif
  76