STAR
Cal STAR — firmware, DAQ server, and engine design
Loading...
Searching...
No Matches
EthernetClass Class Reference

#include <Ethernet.h>

Collaboration diagram for EthernetClass:
[legend]

Public Member Functions

int begin (uint8_t *, unsigned long, unsigned long)
 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.
void begin (uint8_t *, IPAddress ip, IPAddress, IPAddress, IPAddress mask)
 Static form.
void setLocalIP (const IPAddress ip)
void setSubnetMask (const IPAddress mask)
IPAddress localIP () const
IPAddress subnetMask () const
int maintain ()
void reset ()

Public Attributes

IPAddress local_ip
IPAddress subnet_mask
int set_local_ip_calls = 0
int set_subnet_calls = 0
bool dhcp_should_succeed = false
IPAddress dhcp_assigned
int maintain_calls = 0
int static_begin_calls = 0
IPAddress static_ip
IPAddress static_subnet
int dhcp_begin_calls = 0

Detailed Description

Definition at line 45 of file Ethernet.h.

Member Function Documentation

◆ begin() [1/2]

void EthernetClass::begin ( uint8_t * ,
IPAddress ip,
IPAddress ,
IPAddress ,
IPAddress mask )
inline

Static form.

Definition at line 75 of file Ethernet.h.

References local_ip, static_begin_calls, static_ip, static_subnet, and subnet_mask.

◆ begin() [2/2]

int EthernetClass::begin ( uint8_t * ,
unsigned long ,
unsigned long  )
inline

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.

Definition at line 66 of file Ethernet.h.

References dhcp_assigned, dhcp_begin_calls, dhcp_should_succeed, IPAddress, and local_ip.

◆ localIP()

IPAddress EthernetClass::localIP ( ) const
inline

Definition at line 91 of file Ethernet.h.

References local_ip.

◆ maintain()

int EthernetClass::maintain ( )
inline

Definition at line 97 of file Ethernet.h.

References maintain_calls.

◆ reset()

void EthernetClass::reset ( )
inline

Definition at line 101 of file Ethernet.h.

References dhcp_assigned, dhcp_begin_calls, dhcp_should_succeed, IPAddress, local_ip, maintain_calls, set_local_ip_calls, set_subnet_calls, static_begin_calls, static_ip, static_subnet, and subnet_mask.

◆ setLocalIP()

void EthernetClass::setLocalIP ( const IPAddress ip)
inline

Definition at line 83 of file Ethernet.h.

References local_ip, and set_local_ip_calls.

◆ setSubnetMask()

void EthernetClass::setSubnetMask ( const IPAddress mask)
inline

Definition at line 87 of file Ethernet.h.

References set_subnet_calls, and subnet_mask.

◆ subnetMask()

IPAddress EthernetClass::subnetMask ( ) const
inline

Definition at line 94 of file Ethernet.h.

References subnet_mask.

Member Data Documentation

◆ dhcp_assigned

IPAddress EthernetClass::dhcp_assigned

Definition at line 54 of file Ethernet.h.

Referenced by begin(), and reset().

◆ dhcp_begin_calls

int EthernetClass::dhcp_begin_calls = 0

Definition at line 62 of file Ethernet.h.

Referenced by begin(), and reset().

◆ dhcp_should_succeed

bool EthernetClass::dhcp_should_succeed = false

Definition at line 53 of file Ethernet.h.

Referenced by begin(), and reset().

◆ local_ip

IPAddress EthernetClass::local_ip

Definition at line 47 of file Ethernet.h.

Referenced by begin(), begin(), localIP(), reset(), and setLocalIP().

◆ maintain_calls

int EthernetClass::maintain_calls = 0

Definition at line 55 of file Ethernet.h.

Referenced by maintain(), and reset().

◆ set_local_ip_calls

int EthernetClass::set_local_ip_calls = 0

Definition at line 49 of file Ethernet.h.

Referenced by reset(), and setLocalIP().

◆ set_subnet_calls

int EthernetClass::set_subnet_calls = 0

Definition at line 50 of file Ethernet.h.

Referenced by reset(), and setSubnetMask().

◆ static_begin_calls

int EthernetClass::static_begin_calls = 0

Definition at line 58 of file Ethernet.h.

Referenced by begin(), and reset().

◆ static_ip

IPAddress EthernetClass::static_ip

Definition at line 59 of file Ethernet.h.

Referenced by begin(), and reset().

◆ static_subnet

IPAddress EthernetClass::static_subnet

Definition at line 60 of file Ethernet.h.

Referenced by begin(), and reset().

◆ subnet_mask

IPAddress EthernetClass::subnet_mask

Definition at line 48 of file Ethernet.h.

Referenced by begin(), reset(), setSubnetMask(), and subnetMask().

The documentation for this class was generated from the following file:
  • firmware/Hotfire_Code/Hotfire_Tests/stubs/Ethernet.h