uw-aloha-q-node.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 UW_ALOHA_Q_NODE_H
#define UW_ALOHA_Q_NODE_H
 
#include <mmac.h>
#include <deque>
#include <iostream>
#include <assert.h>
#include <sys/time.h>
#include <string>
 
#include <mphy.h>
 
#include <vector>
 
extern packet_t PT_MMAC_ACK;
 
#define UW_ALOHAQ_STATUS_MY_SLOT 1 
#define UW_ALOHAQ_STATUS_NOT_MY_SLOT 2 
class UwAloha_Q_NODE;
 
class UwAlohaQTimer : public TimerHandler
{
 
public:
    UwAlohaQTimer(UwAloha_Q_NODE *m)
        : TimerHandler()
    {
        assert(m != NULL);
        module = m;
    }
 
protected:
    virtual void expire(Event *e);
    UwAloha_Q_NODE *module;
};
 
class UwAloha_Q_NODE : public MMac
{
 
    friend class UwAlohaQTimer;
 
public:
    UwAloha_Q_NODE();
 
    virtual ~UwAloha_Q_NODE() = default;
 
 
    virtual int recvSyncClMsg(ClMessage* m);
 
protected:
    enum UWALOHAQ_PKT_TYPE{
        UWALOHAQ_ACK_PKT,
        UWALOHAQ_DATA_PKT
    };
    
    virtual int decide_if_backoff(int slot); 
    
    virtual void stateRxAck(Packet *p); 
    
    virtual int getLayerIdFromTag(const std::string& tag);
    
    virtual int  findMySlot();
    
    virtual void updateQ_table(int ack_received); 
    
    virtual void handleTimerExpiration();
    
    virtual void txData();
    virtual void start(double delay);
    virtual void stop();
    virtual void recvFromUpperLayers(Packet *p) override;
    virtual void Phy2MacEndRx(Packet *p);
    virtual void Phy2MacStartRx(const Packet *p);
    virtual void Phy2MacEndTx(const Packet *p);
    virtual void rxPacketNotForMe(Packet *p);
    virtual void initPkt(Packet *p);
 
    virtual int command(int argc, const char *const *argv);
    enum UWALOHAQ_STATUS { IDLE, TRANSMITTING, RECEIVING, WAIT_ACK };
    enum UWALOHAQ_ACK_STATUS { ACK_RECEIVED, ACK_NOT_RECEIVED };
    enum UWALOHAQ_BACKOFF_STATUS {ADD_BACKOFF, HALT} ;
    enum UWALOHAQ_BACKOFF_MODE {B1, B2};
    
    UwAlohaQTimer alohaq_timer; 
    int slot_status; 
    double slot_duration; 
    std::vector <double> Q_table {};
    double start_time; 
    UWALOHAQ_STATUS transceiver_status; 
    UWALOHAQ_ACK_STATUS ack_status; 
    UWALOHAQ_BACKOFF_STATUS backoff_status; 
    UWALOHAQ_BACKOFF_MODE backoff_mode; 
    double guard_time; 
    int tot_slots; 
    int HDR_size; 
    int max_packet_per_slot; 
    int packet_sent_curr_slot_; 
    int packet_sent_curr_frame; 
    int max_queue_size; 
    bool enable;
    
    int debug_; 
    int sea_trial_; 
    std::deque<Packet *> buffer; 
    int curr_slot; 
    int my_curr_slot; 
    int data_phy_id; 
    int decide_backoff;  
    std::string phy_data_tag;
};
 
#endif