uwmodem.h

Go to the documentation of this file.

//
// Copyright (c) 2018 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 UWMODEM_H
#define UWMODEM_H
 
#include <iostream>
#include <memory>
#include <queue>
#include <string>
 
#include <functional>
#include <hdr-uwal.h>
#include <mac.h>
#include <mphy.h>
#include <tclcl.h>
#include <uwal.h>
#include <uwip-module.h>
 
class CheckTimer;
struct ModemEvent;
class UwModem : public MPhy
{
    friend class CheckTimer;
 
public:
    enum class LogLevel { ERROR = 0, INFO = 1, DEBUG = 2 };
 
    static bool string2log(const std::string &ll_string, LogLevel &ll);
 
    static bool log2string(LogLevel ll, std::string &ll_string);
 
    UwModem();
 
    virtual ~UwModem();
 
    virtual void recv(Packet *p) = 0;
 
    virtual int command(int argc, const char *const *argv);
 
    virtual int recvSyncClMsg(ClMessage *m) = 0;
 
    virtual double
    getTxDuration(Packet *p)
    {
        return -1.0;
    }
 
    virtual int
    getModulationType(Packet *P)
    {
        return 0;
    }
 
    void
    setModemID(int ID)
    {
        modemID = ID;
    }
 
    int
    getModemID()
    {
        return modemID;
    }
 
    void printOnLog(LogLevel log_level, string module, string message);
 
    LogLevel
    getLogLevel()
    {
        return loglevel_;
    }
 
    int
    getDebug()
    {
        return debug_;
    }
 
    std::string
    getLogFile()
    {
        return logFile + std::to_string(modemID) + log_suffix;
    }
 
    void
    realTxEnded(Packet *p)
    {
        endTx(p);
    }
 
protected:
    int modemID; 
    std::vector<char> data_buffer;
 
    std::queue<Packet *> tx_queue;
 
    std::queue<Packet *> rx_queue;
 
    unsigned int DATA_BUFFER_LEN;
 
    int MAX_READ_BYTES;
 
    std::string modem_address;
 
    int debug_;
 
    std::ofstream outLog; 
    std::string logFile; 
    std::string log_suffix; 
    LogLevel loglevel_; 
    bool log_is_open; 
    CheckTimer *checkTimer; 
    double period; 
    std::queue<ModemEvent> event_q;
 
    virtual void startTx(Packet *p) = 0;
 
    virtual void endTx(Packet *p);
 
    virtual void startRx(Packet *p) = 0;
 
    virtual void endRx(Packet *p) = 0;
 
    virtual void start() = 0;
 
    virtual void stop() = 0;
 
    void checkEvent();
};
 
class CheckTimer : public TimerHandler
{
public:
    CheckTimer(UwModem *pmModem_)
        : TimerHandler()
    {
        pmModem = pmModem_;
        if (pmModem->getDebug() >= 2) {
            std::cout
                    << this
                    << ": in constructor of CheckTimer which points to modem: "
                    << pmModem << std::endl;
        }
    }
 
protected:
    virtual void expire(Event *e);
 
    UwModem *pmModem; 
};
 
struct ModemEvent {
    std::function<void(UwModem &, Packet *p)> f;
    Packet *p;
};
 
#endif