ncp.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-2001 Fritz Elfert <felfert@to.com>
 *  Copyright (C) 2026 Jason Morley <hello@jbmorley.co.uk>
 *
 *  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/>.
 *
 */
#pragma once
 
#include "config.h"
 
#include <vector>
 
#include "bufferstore.h"
#include "linkchannel.h"
#include "ncpstatuscallback.h"
#include "tcpsocket.h"
 
#define MAX_CHANNELS_PSION 256
#define MAX_CHANNELS_SIBO  8
#define NCP_SENDLEN 250
 
class Link;
class Channel;
 
class PcServer {
public:
    PcServer(TCPSocket *, std::string _name) { name = _name; }
    ~PcServer() {}
    bool clientConnect(int, int) { return false; }
    std::string getName() { return name; }
    PcServer *self() { return this; }
private:
    std::string name;
};
 
class NCP {
public:
    NCP(const char *fname,
        int baud,
        bool noDSRCheck,
        unsigned short verbose,
        const int cancellationFd,
        NCPStatusCallback statusCallback,
        void *context);
    ~NCP();
 
    int connect(Channel *c); // returns channel, or -1 if failure
    void Register(Channel *c);
    void RegisterAck(int, const char *);
    void disconnect(int channel);
    void send(int channel, BufferStore &a);
    void reset();
    int  maxLinks();
    bool stuffToSend();
    bool hasFailed();
    bool gotLinkChannel();
 
    PcServer *findPcServer(const char *name);
    void registerPcServer(TCPSocket *skt, const char *name);
    void unregisterPcServer(PcServer *server);
 
    short int getProtocolVersion();
    int getSpeed();
 
private:
    friend class Link;
 
    enum c { MAX_LEN = 200, LAST_MESS = 1, NOT_LAST_MESS = 2 };
    enum interControllerMessageType {
        // Inter controller message types
        NCON_MSG_DATA_XOFF=1,
        NCON_MSG_DATA_XON=2,
        NCON_MSG_CONNECT_TO_SERVER=3,
        NCON_MSG_CONNECT_RESPONSE=4,
        NCON_MSG_CHANNEL_CLOSED=5,
        NCON_MSG_NCP_INFO=6,
        NCON_MSG_CHANNEL_DISCONNECT=7,
        NCON_MSG_NCP_END=8
    };
    enum protocolVersionType { PV_SERIES_5 = 6, PV_SERIES_3 = 3 };
    void receive(BufferStore s);
    int getFirstUnusedChan();
    bool isValidChannel(int);
    void decodeControlMessage(BufferStore &buff);
    void controlChannel(int chan, enum interControllerMessageType t, BufferStore &command);
    const char * ctrlMsgName(unsigned char);
 
    Link *l;
    unsigned short verbose;
    Channel **channelPtr;
    BufferStore *messageList;
    int *remoteChanList;
    bool failed = false;
    short int protocolVersion;
    LinkChannel *lChan;
    int maxChannels;
    std::vector<PcServer> pcServers;
    int lastSentChannel;
    NCPStatusCallback statusCallback_;
    void *callbackContext_;
};