teensy_ethernet_server.h

Go to the documentation of this file.

#pragma once
 
#include <QNEthernet.h>
 
#include <net/ethernet_client.h>
#include <net/ethernet_server_hal.h>
 
namespace qn = qindesign::network;
 
namespace net {
 
class TeensyEthernetServerHAL : public EthernetServerHAL {
public:
  // Returns the server port. This will return -1 if it has not been set.
  //
  // Note that the value is still a 16-bit quantity if it is non-negative.
  int32_t port() const;
 
  // Starts listening on the server port, if set. This does not set the
  // SO_REUSEADDR socket option.
  //
  // This first calls end() if the _reuse_ socket option differs.
  void begin() override;
 
  // Starts listening on the server port, if set, and sets the SO_REUSEADDR
  // socket option. This returns whether the server started listening. This will
  // always return false if the port is not set.
  //
  // This first calls end() if the _reuse_ socket option differs.
  bool beginWithReuse() override;
 
  // Starts listening on the specified port. This does not set the SO_REUSEADDR
  // socket option. This returns whether the server started listening.
  //
  // This first calls end() if the port or _reuse_ socket option differ.
  bool begin(uint16_t port) override;
 
  // Starts listening on the specified port, if set, and sets the SO_REUSEADDR
  // socket option. This returns whether the server started listening.
  //
  // If the port or _reuse_ socket option differ then this first calls end() to
  // prevent a single server object from representing more than one
  // listening socket.
  bool beginWithReuse(uint16_t port) override;
 
  // Stops listening. This does nothing if the port is not set or the server is
  // not listening.
  void end() override;
 
  // Accepts a connection and returns a client, possibly unconnected. This
  // returns an unconnected client if the port is not set.
  net::EthernetClient accept() override;
 
  // Finds a connection with available data. This returns an unconnected client
  // if there is no client with available data or if the port is not set.
  net::EthernetClient available() const override;
 
  // Writes a byte to all the connections. This does nothing and returns 1 if
  // the port is not set.
  size_t write(uint8_t b) override;
 
  // Writes data to all the connections. This does nothing and returns size if
  // the port is not set.
  size_t write(const uint8_t *buffer, size_t size) override;
 
  // Returns the minimum availability of all the connections, or zero if there
  // are no connections or if the port is not set.
  int availableForWrite() override;
 
  // Flushes all the connections, but does nothing is the port is not set.
  void flush() override;
 
  explicit operator bool() override;
 
private:
  qn::EthernetServer impl_;
};
 
} // namespace net