uwrov-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 UWROV_MODULE_H
#define UWROV_MODULE_H
 
#include "uwsmposition.h"
#include "uwcbr-module.h"
#include "uwrov-packet.h"
 
#include <fstream>
 
#define UWROV_DROP_REASON_UNKNOWN_TYPE "UKT" 
#define UWROV_DROP_REASON_OUT_OF_SEQUENCE "OOS" 
#define UWROV_DROP_REASON_DUPLICATED_PACKET "DPK" 
#define HDR_UWROV_MONITORING(p) (hdr_uwROV_monitoring::access(p))
#define HDR_UWROV_CTR(p) (hdr_uwROV_ctr::access(p))
 
class UwROVModule;
 
class UwROVSendAckTimer : public TimerHandler
{
public:
    UwROVSendAckTimer(UwROVModule *m)
        : TimerHandler()
    {
        module = m;
    }
 
protected:
    virtual void expire(Event *e);
    UwROVModule *module;
};
 
class UwROVModule : public UwCbrModule
{
    friend class UwROVSendAckTimer;
 
public:
    UwROVModule();
 
    virtual ~UwROVModule() = default;
 
    virtual int command(int argc, const char *const *argv) override;
 
    virtual void initPkt(Packet *p) override;
 
    virtual void recv(Packet *) override;
 
    virtual void recv(Packet *p, Handler *h) override;
 
    static int
    getROVMonHeaderSize()
    {
        return sizeof(hdr_uwROV_monitoring);
    }
 
    static int
    getROVCTRHeaderSize()
    {
        return sizeof(hdr_uwROV_ctr);
    }
 
    virtual void sendAck();
 
protected:
    enum UWROV_ACK_POLICY { ACK_PIGGYBACK, ACK_IMMEDIATELY, ACK_PGBK_OR_TO };
 
    int last_sn_confirmed; 
    int ack; 
    int ackPriority; 
    int ackNotPgbk; 
    int drop_old_waypoints; 
    int ackTimeout; 
    UWSMPosition *posit; 
    UwROVSendAckTimer ackTimer_; 
    UWROV_ACK_POLICY ackPolicy;
 
    int log_flag; 
    std::ofstream out_file_stats; 
};
 
#endif // UWROV_MODULE_H