ethernet.h File Reference

Defines an EthernetDriver class for managing Ethernet communication, including sending and receiving data, handling MAC addresses, and event management. More...

#include <cstdint>
#include <drivers/driver.h>
#include <common/vector.h>
#include <common/eventHandler.h>

Go to the source code of this file.

Classes
class	MaxOS::drivers::ethernet::BeforeSendEvent
	Event that is triggered before data is sent, holds the buffer and size of the data. More...
class	MaxOS::drivers::ethernet::DataSentEvent
	Event that is triggered when data is sent, holds the buffer and size of the data. More...
class	MaxOS::drivers::ethernet::DataReceivedEvent
	Event that is triggered when data is received, holds the buffer and size of the data. More...
class	MaxOS::drivers::ethernet::EthernetDriverEventHandler
	Handles the events that are triggered by the Ethernet Driver. More...
class	MaxOS::drivers::ethernet::EthernetDriver
	Driver for the Ethernet Controller, manages the sending and receiving of data, the mac address, and the events. More...

Typedefs
typedef uint64_t	MaxOS::drivers::ethernet::MediaAccessControlAddress
	Used to make MAC addresses more readable.

Enumerations
enum class	MaxOS::drivers::ethernet::EthernetDriverEvents { BEFORE_SEND , DATA_SENT , DATA_RECEIVED }
	Events that can be triggered by the Ethernet Driver. More...

Detailed Description

Defines an EthernetDriver class for managing Ethernet communication, including sending and receiving data, handling MAC addresses, and event management.

Date

1st December 2022

Author

Max Tyson

Definition in file ethernet.h.

Typedef Documentation

MediaAccessControlAddress

typedef uint64_t MaxOS::drivers::ethernet::MediaAccessControlAddress

Used to make MAC addresses more readable.

Todo:

make a MacAddress class and use mac_t

Definition at line 21 of file ethernet.h.

Enumeration Type Documentation

EthernetDriverEvents

enum class MaxOS::drivers::ethernet::EthernetDriverEvents

strong

Events that can be triggered by the Ethernet Driver.

Definition at line 27 of file ethernet.h.

                                    {
        BEFORE_SEND,
        DATA_SENT,
        DATA_RECEIVED
    };