mirror of
https://github.com/DCC-EX/CommandStation-EX.git
synced 2024-11-23 08:06:13 +01:00
92 lines
2.9 KiB
C++
92 lines
2.9 KiB
C++
/*
|
|
* © 2020, Gregor Baues. All rights reserved.
|
|
*
|
|
* This 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 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* It 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 with CommandStation. If not, see <https://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#ifndef NetworkInterface_h
|
|
#define NetworkInterface_h
|
|
|
|
#include <Arduino.h>
|
|
|
|
#include "NetworkConfig.h"
|
|
#include "HttpRequest.h"
|
|
|
|
typedef enum protocolType {
|
|
TCP,
|
|
UDPR, // UDP clashes with a class name in the network stack
|
|
MQTT
|
|
} protocolType;
|
|
|
|
typedef enum transportType {
|
|
WIFI, // using an AT (Version >= V1.7) command enabled ESP8266 not to be used in conjunction with the WifiInterface though! not tested for conflicts
|
|
ETHERNET // using the EthernetShield
|
|
} transportType;
|
|
|
|
using HttpCallback = void(*)(ParsedRequest *req, Client *client);
|
|
|
|
/**
|
|
* @brief Abstract parent class of the templated ( Ethernet or Wifi ) class
|
|
* Instances of Transports are hold through this in an array in DCCNetwork which describes and
|
|
* actually manages the available transports.
|
|
*/
|
|
struct AbstractTransport {
|
|
void loop(){};
|
|
virtual ~AbstractTransport(){};
|
|
};
|
|
|
|
/**
|
|
* @brief Core class holding and running the instantiated Transports
|
|
* initalized through the NetworkInterface. The number of transports is
|
|
* limited by MAX_INTERFACES
|
|
*
|
|
*/
|
|
class DCCNetwork {
|
|
private:
|
|
byte _tCounter = 0;
|
|
transportType _t[MAX_INTERFACES];
|
|
public:
|
|
AbstractTransport *transports[MAX_INTERFACES];
|
|
|
|
byte add(AbstractTransport* t, transportType _t);
|
|
void loop();
|
|
};
|
|
|
|
/**
|
|
* @brief Main entry point and provider of callbacks. Sole responsibility is to create
|
|
* the transport endpoints and loop over them for processing
|
|
*
|
|
*/
|
|
class NetworkInterface
|
|
{
|
|
private:
|
|
HttpCallback httpCallback;
|
|
transportType t;
|
|
|
|
public:
|
|
|
|
void setHttpCallback(HttpCallback callback);
|
|
HttpCallback getHttpCallback();
|
|
void setup(transportType t, protocolType p, uint16_t port); // specific port nummber
|
|
void setup(transportType t, protocolType p); // uses default port number
|
|
void setup(transportType t); // defaults for protocol/port
|
|
|
|
void setup(); // defaults for all as above plus CABLE (i.e. using EthernetShield ) as default
|
|
static void loop();
|
|
|
|
NetworkInterface();
|
|
~NetworkInterface();
|
|
};
|
|
|
|
#endif |