Mistake on this page?
Report an issue in GitHub or email us
Public Member Functions
Ethernet Class Reference

An ethernet interface, to use with the ethernet pins. More...

#include <Ethernet.h>

Inheritance diagram for Ethernet:
NonCopyable< Ethernet >

Public Member Functions

 Ethernet ()
 
virtual ~Ethernet ()
 
int write (const char *data, int size)
 
int send ()
 
int receive ()
 
int read (char *data, int size)
 
void address (char *mac)
 
int link ()
 
void set_link (Mode mode)
 

Detailed Description

An ethernet interface, to use with the ethernet pins.

Deprecated:
EthInterface is now the preferred way to get an Ethernet object. Alternatively, use NetworkInterface to get an instance of an appropriate network interface (WiFi or Ethernet).
Note
Synchronization level: Not protected

Example:

// Read destination and source from every ethernet packet
#include "mbed.h"
int main() {
char buf[0x600];
while(1) {
int size = eth.receive();
if(size > 0) {
eth.read(buf, size);
printf("Destination: %02X:%02X:%02X:%02X:%02X:%02X\n",
buf[0], buf[1], buf[2], buf[3], buf[4], buf[5]);
printf("Source: %02X:%02X:%02X:%02X:%02X:%02X\n",
buf[6], buf[7], buf[8], buf[9], buf[10], buf[11]);
}
wait(1);
}
}

Definition at line 70 of file Ethernet.h.

Constructor & Destructor Documentation

Ethernet ( )
Deprecated:
Initialize the ethernet interface.
virtual ~Ethernet ( )
virtual
Deprecated:
Powers the hardware down.

Member Function Documentation

void address ( char *  mac)
Deprecated:
Gives the ethernet address of the mbed.
Parameters
macMust be a pointer to a 6 byte char array to copy the ethernet address in.
int link ( )
Deprecated:
Returns if an ethernet link is present or not.

It takes a while after Ethernet initialization to show up.

Returns
0 if no ethernet link is present, 1 if an ethernet link is present.

Example:

// Using the Ethernet link function
#include "mbed.h"
int main() {
wait(1); // Needed after startup.
if (eth.link()) {
printf("online\n");
} else {
printf("offline\n");
}
}
int read ( char *  data,
int  size 
)
Deprecated:
Read from an received ethernet packet.

After receive returned a number bigger than 0 it is possible to read bytes from this packet.

Parameters
dataPointer to data packet
sizeSize of data to be read.
Returns
The number of byte read.
Note
It is possible to use read multiple times. Each time read will start reading after the last read byte before.
int receive ( )
Deprecated:
Receives an arrived ethernet packet.

Receiving an ethernet packet will drop the last received ethernet packet and make a new ethernet packet ready to read. If no ethernet packet is arrived it will return 0.

Returns
0 if no ethernet packet is arrived, or the size of the arrived packet.
int send ( )
Deprecated:
Send an outgoing ethernet packet.

After filling in the data in an ethernet packet it must be send. Send will provide a new packet to write to.

Returns
0 if the sending was failed, or the size of the packet successfully sent.
void set_link ( Mode  mode)
Deprecated:
Sets the speed and duplex parameters of an ethernet link
  • AutoNegotiate Auto negotiate speed and duplex
  • HalfDuplex10 10 Mbit, half duplex
  • FullDuplex10 10 Mbit, full duplex
  • HalfDuplex100 100 Mbit, half duplex
  • FullDuplex100 100 Mbit, full duplex

    Parameters
    modethe speed and duplex mode to set the link to:
int write ( const char *  data,
int  size 
)
Deprecated:
Writes into an outgoing ethernet packet.

It will append size bytes of data to the previously written bytes.

Parameters
dataAn array to write.
sizeThe size of data.
Returns
The number of written bytes.
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.