sun-ipr-sink.h

Go to the documentation of this file.

//
// Copyright (c) 2017 Regents of the SIGNET lab, University of Padova.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// 1. Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
// 2. 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.
// 3. Neither the name of the University of Padova (SIGNET lab) 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.
//
 
#ifndef SUN_SINK_H
#define SUN_SINK_H
 
#include "sun-hdr-ack.h"
#include "sun-hdr-data.h"
#include "sun-hdr-pathestablishment.h"
#include "sun-hdr-probe.h"
#include "sun-ipr-common-structures.h"
 
#include <uwcbr-module.h>
#include <uwip-clmsg.h>
#include <uwip-module.h>
 
#include "packet.h"
#include <module.h>
#include <tclcl.h>
 
#include <fstream>
#include <iostream>
#include <rng.h>
#include <sstream>
#include <stdio.h>
#include <stdlib.h>
#include <string>
#include <vector>
 
class SunIPRoutingSink : public Module
{
 
    friend class SendTimer;
 
public:
    class SendTimer : public TimerHandler
    {
    public:
        SendTimer(SunIPRoutingSink *m)
            : TimerHandler()
            , module(m)
        {
        }
 
    protected:
        virtual void expire(Event *e);
 
        SunIPRoutingSink
                *module; 
    };
 
    SunIPRoutingSink();
 
    virtual ~SunIPRoutingSink();
 
protected:
    /*****************************
     |     Internal Functions    |
     *****************************/
    virtual int command(int, const char *const *);
 
    virtual void recv(Packet *);
 
    virtual int recvSyncClMsg(ClMessage *);
 
    virtual int recvAsyncClMsg(ClMessage *);
 
    virtual void initialize();
 
    virtual void sendProbe();
 
    static string printIP(const nsaddr_t &);
 
    static string printIP(const ns_addr_t &);
 
    static nsaddr_t str2addr(const char *);
 
    inline const double
    getDelay(const double &period_) const
    {
        if (PoissonTraffic_)
            return (-log(RNG::defaultrng()->uniform_double()) /
                    (1.0 / period_));
        else
            return 0;
    }
 
    // Timer
    virtual void start();
 
    virtual void stop();
 
    virtual void transmit();
 
    virtual void setProbeTimer(const double &);
 
    virtual const double &getProbeTimer() const;
 
    /*****************************
     |           Acks            |
     *****************************/
    virtual void sendBackAck(const Packet *);
 
    virtual void initPktAck(Packet *);
 
    /*****************************
     |        Statistics         |
     *****************************/
    static inline const int
    getProbePktHeaderSize()
    {
        return sizeof(hdr_sun_probe);
    }
 
    static inline const int
    getAckHeaderSize()
    {
        return sizeof(hdr_sun_ack);
    }
 
    inline const long &
    getProbeCount() const
    {
        return probe_count_;
    }
 
    inline const long &
    getAckCount() const
    {
        return number_of_ackpkt_;
    }
 
    /*****************************
     |         Trace file         |
     *****************************/
    virtual void tracePacket(
            const Packet *const, const string &position = "UNDEF___");
 
    virtual string createTraceString(const string &, const double &,
            const int &, const int &, const int &, const int &, const int &,
            const int &, const int &, const double &, const int &, const int &);
 
    virtual void writeInTrace(const string &);
 
    virtual void writePathInTrace(const Packet *);
 
    // Internal variables
    nsaddr_t ipAddr_; 
    double t_probe; 
    int PoissonTraffic_; 
    double periodPoissonTraffic_; 
    int printDebug_; 
    // Statistics
    static long probe_count_; 
    static long number_of_ackpkt_; 
    int numberofnodes_; 
    unsigned int **arrayofstats_; 
    // Timer
    SendTimer sendTmr_; 
    // Trace file
    bool trace_; 
    bool trace_path_; 
    char *trace_file_name_; 
    char *trace_file_path_name_; 
    ostringstream osstream_; 
    ofstream trace_file_; 
    ofstream trace_file_path_; 
    char trace_separator_; 
private:
    SunIPRoutingSink(const SunIPRoutingSink &);
};
 
#endif // SUN_SINK_H