MaxOS::net::EthernetFramePayloadHandler Class Reference

Handles a specific type of Ethernet Frame payload. More...

#include <ethernetframe.h>

Inheritance diagram for MaxOS::net::EthernetFramePayloadHandler:

Public Member Functions
	EthernetFramePayloadHandler (EthernetFrameHandler *frame_handler, uint16_t handled_type)
	Construct a new Ether Frame Payload Handler object.
	~EthernetFramePayloadHandler ()
	Destroy the EtherFrameHandler:: EtherFrameHandler object, Removes it from the handler list.
virtual bool	handle_ethernetframe_payload (uint8_t *ethernetframe_payload, uint32_t size)
	Handle the received ethernet frame payload.
void	send (uint64_t destination, uint8_t *data, uint32_t size)
	send an packet via the backend driver

Protected Attributes
EthernetFrameHandler *	frame_handler
	The Ethernet frame handler this payload handler is connected to.
uint16_t	handled_type
	The Ethernet frame type this handler handles.

Friends
class	EthernetFrameHandler

Detailed Description

Handles a specific type of Ethernet Frame payload.

Definition at line 57 of file ethernetframe.h.

Constructor & Destructor Documentation

EthernetFramePayloadHandler()

EthernetFramePayloadHandler::EthernetFramePayloadHandler	(	EthernetFrameHandler *	frame_handler,
		uint16_t	handled_type
	)

Construct a new Ether Frame Payload Handler object.

Parameters

frame_handler	the handler for the ethernet frame
handled_type	the type of the protocol, which will be handled by this handler

Definition at line 24 of file ethernetframe.cpp.

                                                                                                                   {
 
    this->handled_type = handled_type;
    this->frame_handler = frame_handler;
    frame_handler->connect_handler(this);
 
 
}

References MaxOS::net::EthernetFrameHandler::connect_handler(), frame_handler, and handled_type.

Member Function Documentation

handle_ethernetframe_payload()

bool EthernetFramePayloadHandler::handle_ethernetframe_payload ( uint8_t *  ethernetframe_payload, uint32_t  size  )

virtual

Handle the received ethernet frame payload.

Parameters

ethernetframe_payload	the payload of the ethernet frame
size	the size of the payload

Returns

True if the data is to be sent back, false otherwise

Reimplemented in MaxOS::net::AddressResolutionProtocol, and MaxOS::net::InternetProtocolHandler.

Definition at line 48 of file ethernetframe.cpp.

                                                                                                            {
 
    //By default, don't handle it, will be handled in the override
    return false;
 
}

send()

void EthernetFramePayloadHandler::send	(	uint64_t	destination,
		uint8_t *	data,
		uint32_t	size
	)

send an packet via the backend driver

Parameters

destination	the destination MAC address
data	the data to send
size	the size of the payload

Definition at line 62 of file ethernetframe.cpp.

                                                                                         {
 
    frame_handler->send_ethernet_frame(destination, handled_type, data, size);
}

References frame_handler, handled_type, and MaxOS::net::EthernetFrameHandler::send_ethernet_frame().

Referenced by MaxOS::net::AddressResolutionProtocol::request_mac_address().

Friends And Related Symbol Documentation

EthernetFrameHandler

friend class EthernetFrameHandler

friend

Definition at line 58 of file ethernetframe.h.

Member Data Documentation

frame_handler

EthernetFrameHandler* MaxOS::net::EthernetFramePayloadHandler::frame_handler

protected

The Ethernet frame handler this payload handler is connected to.

Definition at line 61 of file ethernetframe.h.

Referenced by EthernetFramePayloadHandler(), MaxOS::net::InternetProtocolHandler::get_media_access_control_address(), MaxOS::net::AddressResolutionProtocol::request_mac_address(), send(), and MaxOS::net::InternetProtocolHandler::send_internet_protocol_packet().

handled_type

uint16_t MaxOS::net::EthernetFramePayloadHandler::handled_type

protected

The Ethernet frame type this handler handles.

Definition at line 62 of file ethernetframe.h.

Referenced by EthernetFramePayloadHandler(), send(), and MaxOS::net::InternetProtocolHandler::send_internet_protocol_packet().

---

The documentation for this class was generated from the following files:

• /home/runner/work/MaxOS/MaxOS/kernel/include/net/ethernetframe.h
• /home/runner/work/MaxOS/MaxOS/kernel/src/net/ethernetframe.cpp