uwmodamodem.h

Go to the documentation of this file.

//
// Copyright (c) 2019 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 UWMODAMODEM_H
#define UWMODAMODEM_H
 
#include <uwconnector.h>
#include <uwmodem.h>
#include <uwsocket.h>
 
#include <atomic>
#include <condition_variable>
#include <map>
#include <mutex>
#include <string>
#include <thread>
#include <vector>
 
class UwMODAModem : public UwModem
{
 
public:
    enum class ModemState {
        AVAILABLE = 0,
        TRANSMITTING,
        RECEIVING,
        CONFIGURING
    };
 
    enum class ModemResponse { UNDEFINED = 0, TX_END, RX_BEG, CFG_END };
 
    UwMODAModem();
 
    virtual ~UwMODAModem();
 
    virtual void recv(Packet *p);
 
    virtual int command(int argc, const char *const *argv);
 
    virtual int getModulationType(Packet *p);
 
    virtual double getTxDuration(Packet *p);
 
    virtual int recvSyncClMsg(ClMessage *m);
 
protected:
    virtual void startTx(Packet *p);
 
    virtual void startRx(Packet *p);
 
    virtual void endRx(Packet *p);
 
    ModemState status; 
private:
    void start();
 
    void stop();
 
    void receivingSignaling();
 
    void receivingData();
 
    void createRxPacket(Packet *p);
 
    void transmittingData();
 
    ModemResponse parseSignaling(std::vector<char>::iterator &end_it);
 
    void updateStatus(ModemResponse response);
 
    std::mutex status_m;
    std::condition_variable status_cv;
    std::mutex tx_queue_m;
    std::condition_variable tx_queue_cv;
    std::atomic<bool> receiving;
    std::atomic<bool> transmitting;
 
    std::string rx_payload;
    int rx_size;
 
    std::thread
            sig_thread; 
    std::thread rx_thread; 
    std::thread tx_thread; 
    static std::vector<std::pair<std::string, ModemResponse>> signaling_dict;
 
    static std::map<ModemState, std::string> stateToString;
 
    std::unique_ptr<UwConnector> signal_conn;
    static const int SIGNALING_ADDRESS; 
    std::unique_ptr<UwConnector> data_conn;
    static const int DATA_ADDRESS; 
    std::vector<char> signal_buffer;
 
    const static std::chrono::milliseconds MODEM_TIMEOUT;
 
    const std::string sep = {"::"};
    const std::string end_delim = {";"};
 
    std::string signal_tag;
 
    std::string signal_address;
 
    int premodulation; 
};
 
#endif