Ethernet.h

Go to the documentation of this file.

// Stub: Ethernet.h — for native tests
// Provides EthernetServer/Client/UDP stubs, plus enough of EthernetClass for
// board_net.h: DHCP can be made to succeed or fail, and every address write is
// recorded so a test can assert what the board pushed into the W5500.
#pragma once
#include <Arduino.h>  // IPAddress
 
#include <cstdint>
#include <cstring>
 
class EthernetClient {
public:
    operator bool() {
        return false;
    }
    int available() {
        return 0;
    }
    int read() {
        return -1;
    }
    int read(uint8_t*, int) {
        return 0;
    }
    void stop() {
    }
    void flush() {
    }
    void println(const char*) {
    }
};
 
class EthernetServer {
public:
    EthernetServer(uint16_t) {
    }
    virtual void begin() {
    }
    EthernetClient available() {
        return EthernetClient();
    }
};
 
// Records what board_net.h writes into the chip, so tests can inspect it.
class EthernetClass {
public:
    IPAddress local_ip;
    IPAddress subnet_mask;
    int set_local_ip_calls = 0;
    int set_subnet_calls = 0;
 
    // --- DHCP, scripted by the test ---
    bool dhcp_should_succeed = false;
    IPAddress dhcp_assigned;
    int maintain_calls = 0;
    // --- static configuration, recorded so a test can prove it did or did
    //     not happen ---
    int static_begin_calls = 0;
    IPAddress static_ip;
    IPAddress static_subnet;
 
    int dhcp_begin_calls = 0;
 
    /** DHCP form: returns 1 on success, 0 on failure, like Ethernet 2.x —
     *  which zeroes the address before asking, so a failure leaves 0.0.0.0. */
    int begin(uint8_t*, unsigned long, unsigned long) {
        dhcp_begin_calls++;
        local_ip = IPAddress(0, 0, 0, 0);
        if (!dhcp_should_succeed)
            return 0;
        local_ip = dhcp_assigned;
        return 1;
    }
    /** Static form. */
    void begin(uint8_t*, IPAddress ip, IPAddress, IPAddress, IPAddress mask) {
        static_begin_calls++;
        static_ip = ip;
        static_subnet = mask;
        local_ip = ip;
        subnet_mask = mask;
    }
 
    void setLocalIP(const IPAddress ip) {
        local_ip = ip;
        set_local_ip_calls++;
    }
    void setSubnetMask(const IPAddress mask) {
        subnet_mask = mask;
        set_subnet_calls++;
    }
    IPAddress localIP() const {
        return local_ip;
    }
    IPAddress subnetMask() const {
        return subnet_mask;
    }
    int maintain() {
        maintain_calls++;
        return 0;
    }
    void reset() {
        local_ip = IPAddress();
        subnet_mask = IPAddress();
        set_local_ip_calls = 0;
        set_subnet_calls = 0;
        dhcp_should_succeed = false;
        dhcp_assigned = IPAddress();
        maintain_calls = 0;
        static_begin_calls = 0;
        static_ip = IPAddress();
        static_subnet = IPAddress();
        dhcp_begin_calls = 0;
    }
};
 
static EthernetClass Ethernet;