link.h

Go to the documentation of this file.

/*
 * This file is part of plptools.
 *
 *  Copyright (C) 1999 Philip Proudman <philip.proudman@btinternet.com>
 *  Copyright (C) 1999-2002 Fritz Elfert <felfert@to.com>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  along with this program; if not, see <https://www.gnu.org/licenses/>.
 *
 */
#ifndef _link_h_
#define _link_h_
 
#include "config.h"
#include <pthread.h>
#include <sys/time.h>
 
#include "bufferstore.h"
#include "bufferarray.h"
#include "Enum.h"
#include <vector>
 
class NCP;
class packet;
 
typedef struct {
    int seq;
    int txcount;
    struct timeval stamp;
    bufferStore data;
} ackWaitQueueElement;
 
extern "C" {
    static void *expire_check(void *);
}
 
class Link {
public:
 
    enum link_type {
        LINK_TYPE_UNKNOWN = 0,
        LINK_TYPE_SIBO    = 1,
        LINK_TYPE_EPOC    = 2,
    };
 
    Link(const char *fname, int baud, NCP *ncp, unsigned short verbose, const int cancellationFd);
 
    ~Link();
 
    void send(const bufferStore &buff);
 
    bool stuffToSend();
 
    bool hasFailed();
 
    void reset();
 
    void flush();
 
    void purgeQueue(int channel);
 
    void setVerbose(unsigned short _verbose);
 
    unsigned short getVerbose();
 
    Enum<link_type> getLinkType();
 
    int getSpeed();
 
private:
    friend class packet;
    friend void * expire_check(void *);
 
    void receive(bufferStore buf);
    void transmit(bufferStore buf);
    void sendAck(int seq);
    void sendReqReq();
    void sendReqCon();
    void sendReq();
    void multiAck(struct timeval);
    void retransmit();
    void transmitHoldQueue(int channel);
    void transmitWaitQueue();
    void purgeAllQueues();
    unsigned long retransTimeout();
 
    pthread_t checkthread;
    pthread_mutex_t queueMutex;
 
    NCP *theNCP;
    packet *p;
    int txSequence;
    int rxSequence;
    int seqMask;
    int maxOutstanding;
    unsigned long conMagic;
    unsigned short verbose;
    bool failed;
    Enum<link_type> linkType;
 
    std::vector<ackWaitQueueElement> ackWaitQueue;
    std::vector<bufferStore> holdQueue;
    std::vector<bufferStore> waitQueue;
    bool xoff[256];
};
 
#endif