uwApplication_module.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 UWAPPLICATION_MODULE_H
#define UWAPPLICATION_MODULE_H
 
#include <uwApplication_cmn_header.h>
#include <module.h>
 
#include <arpa/inet.h>
#include <netdb.h>
#include <netinet/in.h>
#include <sys/socket.h>
#include <sys/types.h>
 
#include <atomic>
#include <chrono>
#include <mutex>
#include <queue>
#include <thread>
 
#define UWAPPLICATION_DROP_REASON_UNKNOWN_TYPE \
    "DPUT" 
#define UWAPPLICATION_DROP_REASON_DUPLICATED_PACKET \
    "DPD" 
#define UWAPPLICATION_DROP_REASON_OUT_OF_SEQUENCE \
    "DOOS" 
class uwApplicationModule;
 
class uwSendTimerAppl : public TimerHandler
{
public:
    uwSendTimerAppl(uwApplicationModule *m)
        : TimerHandler()
    {
        module = m;
    }
 
protected:
    virtual void expire(Event *e);
    uwApplicationModule *module;
};
 
class uwApplicationModule : public Module
{
    friend class uwSendTimerAppl;
 
public:
    uwApplicationModule();
 
    virtual ~uwApplicationModule();
 
    virtual int command(int argc, const char *const *argv) override;
 
    virtual void recv(Packet *) override;
 
    virtual double GetFTT() const;
    virtual double GetFTTstd() const;
    virtual double GetPER() const;
 
    virtual double GetTHR() const;
 
    virtual double GetRTT() const;
 
    virtual double GetRTTstd() const;
 
    virtual int
    getPktSent() const
    {
        return txsn - 1;
    }
 
    virtual int
    getPktLost() const
    {
        return pkts_lost;
    }
 
    virtual int
    getPktRecv() const
    {
        return pkts_recv;
    }
 
    virtual int
    getPktsOOSequence() const
    {
        return pkts_ooseq;
    }
 
    virtual int
    getPktsInvalidRx() const
    {
        return pkts_invalid;
    }
 
    virtual int
    getPktsPushQueue() const
    {
        return pkts_push_queue;
    }
 
    virtual double
    getPeriod() const
    {
        return period;
    }
 
    std::string
    getEpoch() const
    {
        unsigned long int timestamp =
                (unsigned long int) (std::chrono::duration_cast<
                        std::chrono::milliseconds>(
                        std::chrono::system_clock::now().time_since_epoch())
                                .count());
 
        return to_string(timestamp);
    }
 
    virtual void
    printOnLog(Logger::LogLevel log_level, const std::string &module,
            const std::string &message) const override
    {
        if (enable_log) {
            if (sea_trial)
                logger.printOnLog(log_level,
                        "[" + getEpoch() + "]::" + module + "(" +
                                to_string(node_id) + ")::" + message);
            else
                PlugIn::printOnLog(log_level, module, message);
        }
    }
 
protected:
    virtual void transmit();
 
    virtual bool listenTCP();
 
    virtual void acceptTCP();
 
    virtual void readFromTCP(int clnSock);
 
    virtual bool openConnectionUDP();
 
    virtual void readFromUDP();
 
    virtual void stop();
 
    virtual bool
    withoutSocket()
    {
        return !socket_active;
    }
 
    virtual bool
    useTCP()
    {
        return socket_tcp;
    }
 
    virtual bool
    usePoissonTraffic()
    {
        return (poisson_traffic == 1) ? true : false;
    }
 
    virtual bool
    useDropOutOfOrder()
    {
        return (drop_out_of_order == 1) ? true : false;
    }
 
    virtual void
    incrPktSent()
    {
        txsn++;
    }
 
    virtual void
    incrPktLost(int npkts)
    {
        pkts_lost += npkts;
    }
 
    virtual void
    incrPktRecv()
    {
        pkts_recv++;
    }
    virtual void
    incrPktOoseq()
    {
        pkts_ooseq++;
    }
    virtual void
    incrPktInvalid()
    {
        pkts_invalid++;
    }
 
    virtual void
    incrPktsPushQueue()
    {
        pkts_push_queue++;
    }
 
    virtual double getTimeBeforeNextPkt();
 
    virtual void updateRTT(double rtt);
 
    virtual void updateFTT(double ftt);
 
    virtual void updateThroughput(int bytes, double dt);
 
    bool socket_active; 
    bool socket_tcp; 
    bool *sn_check; 
    uint8_t dst_addr; 
    int poisson_traffic; 
    int payloadsize; 
    int port_num; 
    int drop_out_of_order; 
    int uidcnt; 
    int hrsn; 
    int txsn; 
    int rftt; 
    int pkts_lost; 
    int pkts_recv; 
    int pkts_ooseq; 
    int pkts_invalid; 
    int pkts_push_queue; 
    int pkts_last_reset; 
    int sea_trial; 
    int node_id; 
    int servSockDescr; 
    int clnSockDescr; 
    int servPort; 
    uint32_t esn; 
    int rttsamples; 
    int fttsamples; 
    double period; 
    double lrtime; 
    double sumrtt; 
    double sumrtt2; 
    double sumftt; 
    double sumftt2; 
    double sumbytes; 
    double sumdt; 
    struct sockaddr_in servAddr; 
    struct sockaddr_in clnAddr; 
    std::thread socket_thread; 
    std::mutex socket_mutex; 
    std::atomic<bool> receiving; 
    std::queue<Packet *> queuePckReadTCP; 
    std::queue<Packet *> queuePckReadUDP; 
    uwSendTimerAppl *chkTimerPeriod; 
    static uint MAX_READ_LEN; 
};
#endif /* UWAPPLICATION_MODULE_H */