uwmulti-traffic-range-crt.h

Go to the documentation of this file.

//
// Copyright (c) 2014 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 UWMULTI_TRAFFIC_CONTROL_H
#define UWMULTI_TRAFFIC_CONTROL_H
 
#include "uwmulti-traffic-control.h"
#include <set>
#include <uwip-module.h>
 
extern packet_t PT_MULTI_TR_PROBE;
extern packet_t PT_MULTI_TR_PROBE_ACK;
#define HDR_UWMTR(P) (hdr_uwm_tr::access(P))
// DEFINE BEHAVIORS
enum CONTROL_RANGE_BEHAVIORS { ROBUST = 2, CHECK_RANGE };
 
// DEFINE STATES
enum TRAFFIC_STATES { IDLE = 1, RANGE_CNF_WAIT };
 
struct check_status {
    std::set<int> module_ids;
    int status;
    int robust_id;
};
typedef std::map<int, check_status> StatusMap; 
typedef std::map<int, uint> CounterMap; 
typedef struct hdr_uwm_tr {
    int tr_id_; 
    static int offset_; 
    inline static int &
    offset()
    {
        return offset_;
    }
 
    inline static hdr_uwm_tr *
    access(const Packet *p)
    {
        return (hdr_uwm_tr *) p->access(offset_);
    }
 
    int &
    traffic()
    {
        return tr_id_;
    }
 
} hdr_uwm_tr;
 
class UwMultiTrafficRangeCtr : public UwMultiTrafficControl
{
 
public:
    UwMultiTrafficRangeCtr();
 
    virtual ~UwMultiTrafficRangeCtr()
    {
    }
 
    virtual int command(int, const char *const *);
 
    virtual void recv(Packet *p, int idSrc);
 
    virtual void
    sendDown(Packet *p, double delay = 0)
    {
        if (p != NULL) {
            Module::sendDown(p, delay);
        }
    }
 
    virtual void
    sendDown(int moduleId, Packet *p, double delay = 0)
    {
        if (p != NULL) {
            Module::sendDown(moduleId, p, delay);
        }
    }
 
protected:
    StatusMap status; 
    double check_to_period; 
    int signaling_pktSize; 
    CounterMap tx_probe_cnt; 
    CounterMap rx_probe_cnt; 
    CounterMap tx_probe_ack_cnt; 
    CounterMap rx_probe_ack_cnt; 
    virtual void manageBuffer(int traffic);
 
    virtual int getBestLowerLayer(int traffic, Packet *p = NULL);
 
    virtual void checkRange(
            int traffic, int module_id, uint8_t destAdd = UWIP_BROADCAST);
 
    virtual void manageCheckedLayer(
            int module_id, uint8_t destAdd, bool in_range, int idSrc = 0);
 
    virtual void initStatus(int traffic);
 
    virtual void timerExpired(int traffic);
 
    void incrSignalingCounter(int traffic, CounterMap &map_cnt);
 
    uint getSignalingCounter(int traffic, const CounterMap &map_cnt) const;
 
private:
    class UwCheckRangeTimer : public TimerHandler
    {
    public:
        UwCheckRangeTimer(UwMultiTrafficRangeCtr *m, int traff)
            : TimerHandler()
            , traffic(traff)
            , num_expires(0)
            , max_increment(10)
        {
            module = m;
        }
        ~UwCheckRangeTimer()
        {
        }
        int traffic; 
        int num_expires; 
        int const max_increment; 
    protected:
        virtual void expire(Event *e);
        UwMultiTrafficRangeCtr *module; 
    };
    // Variables
    std::map<int, UwCheckRangeTimer *>
            timers; 
};
 
#endif /* UWMULTI_TRAFFIC_CONTROL_H  */