Vector::BL...netRxError(3)

💅 Vector::BLF::EthernetRxError — ETHERNET_RX_ERROR 💅

okay so bestie, this is from the Library Functions Manual — page Vector::BL...netRxError(3) (yes, the title has BL... in it, and that's not a glitch, it's just the manpage being extra 💀). It's all about Vector::BLF::EthernetRxError, aka ETHERNET_RX_ERROR, and the whole thing is an Ethernet RX error frame. Let's go. 🦋

✨ NAME ✨

Vector::BLF::EthernetRxError — ETHERNET_RX_ERROR.

🌸 SYNOPSIS 🌸

#include <EthernetRxError.h>

Inherits Vector::BLF::ObjectHeader. Periodt. 💅

🎀 Public Types

enum Dir : uint16_t { Rx = 0, Tx = 1, TxRq = 2 }

🫶 Public Types inherited from Vector::BLF::ObjectHeader

enum ObjectFlags : uint32_t { TimeTenMics = 0x00000001, TimeOneNans = 0x00000002 }

💖 Public Member Functions

• void read (AbstractFile &is) override — the read hook for this object.
• void write (AbstractFile &os) override — the write hook for this object.
• uint32_t calculateObjectSize () const override — calculates the objectSize.
• virtual uint16_t calculateStructLength () const — calculates structLength.

💜 Public Member Functions inherited from Vector::BLF::ObjectHeader

• ObjectHeader (const ObjectType objectType, const uint16_t objectVersion=0) — constructor signature exactly as listed, with objectVersion defaulting to 0.
• void read (AbstractFile &is) override — inherited override, same signature energy.
• void write (AbstractFile &os) override — inherited override, same signature energy.
• uint16_t calculateHeaderSize () const override — inherited header-size calculation override.
• uint32_t calculateObjectSize () const override — inherited object-size calculation override.

🌈 Public Member Functions inherited from Vector::BLF::ObjectHeaderBase

• ObjectHeaderBase (const uint16_t headerVersion, const ObjectType objectType) — constructor signature exactly as listed.
• ObjectHeaderBase (const ObjectHeaderBase &)=default — copy constructor, defaulted.
• ObjectHeaderBase & operator= (const ObjectHeaderBase &)=default — copy assignment, defaulted.
• ObjectHeaderBase (ObjectHeaderBase &&)=default — move constructor, defaulted.
• ObjectHeaderBase & operator= (ObjectHeaderBase &&)=default — move assignment, defaulted.

⭐ Public Attributes

• uint16_t structLength {} — length of this structure.
• uint16_t channel {} — the channel of the frame (same tea as lower down, bestie).
• uint16_t dir {} — direction flag.
• uint16_t hardwareChannel {} — HW channel. 0 = invalid.
• uint32_t fcs {} — Frame Check Sum.
• uint16_t frameDataLength {} — number of valid raw ethernet data bytes.
• uint16_t reservedEthernetRxError {} — reserved.
• uint32_t error {} — error field, with the error-code list further down.
• std::vector< uint8_t > frameData {} — max 1600 data bytes per frame.

🌟 Public Attributes inherited from Vector::BLF::ObjectHeader

• uint32_t objectFlags {ObjectFlags::TimeOneNans} — object flags.
• uint16_t clientIndex {} — client index of send node.
• uint16_t objectVersion {0} — object specific version.
• uint64_t objectTimeStamp {} — object timestamp.

🦋 Public Attributes inherited from Vector::BLF::ObjectHeaderBase

• uint32_t signature {ObjectSignature} — signature (ObjectSignature).
• uint16_t headerSize {} — sizeof object header.
• uint16_t headerVersion {} — header version (1).
• uint32_t objectSize {} — object size.
• ObjectType objectType {ObjectType::UNKNOWN} — object type.

---

💖 Detailed Description 💖

ETHERNET_RX_ERROR.

Ethernet RX error frame. That's the whole vibe: an Ethernet receive error frame doing its little thing. 🎀

🔥 Member Enumeration Documentation 🔥

enum Vector::BLF::EthernetRxError::Dir : uint16_t

enumeration for dir.

Enumerator:

• Rx — receive
• Tx — transmit
• TxRq — transmit request

🫶 Member Function Documentation 🫶

uint32_t Vector::BLF::EthernetRxError::calculateObjectSize () const [override], [virtual]

Calculates the objectSize.

Returns: object size.

Reimplemented from Vector::BLF::ObjectHeaderBase.

uint16_t Vector::BLF::EthernetRxError::calculateStructLength () const [virtual]

Calculates structLength.

Returns: struct length.

void Vector::BLF::EthernetRxError::read (AbstractFile & is) [override], [virtual]

Read the data of this object.

Parameters: is input stream.

Reimplemented from Vector::BLF::ObjectHeaderBase.

void Vector::BLF::EthernetRxError::write (AbstractFile & os) [override], [virtual]

Write the data of this object.

Parameters: os output stream.

Reimplemented from Vector::BLF::ObjectHeaderBase.

🍓 Member Data Documentation 🍓

• uint16_t Vector::BLF::EthernetRxError::channel {} — the channel of the frame.
• uint32_t Vector::BLF::EthernetRxError::error {} — error code
  • 1: Data Length Error
  • 2: Invalid CRC
  • 3: Invalid Data received
  • 4: Collision detected
• uint32_t Vector::BLF::EthernetRxError::fcs {} — Frame Check Sum. Ethernet frame checksum.
• std::vector<uint8_t> Vector::BLF::EthernetRxError::frameData {} — max 1600 data bytes per frame. Raw Ethernet frame data. Max 1522 data bytes per frame.
• uint16_t Vector::BLF::EthernetRxError::frameDataLength {} — number of valid raw ethernet data bytes. Number of valid raw ethernet data bytes, starting with Target MAC ID.
• uint16_t Vector::BLF::EthernetRxError::reservedEthernetRxError {} — reserved.
• uint16_t Vector::BLF::EthernetRxError::structLength {} — length of this structure. Length of this structure, without sizeof(ObjectHeader) and without raw data length.

👑 Author 👑

Generated automatically by Doxygen for Vector BLF from the source code. No human author to @, just Doxygen doing its robot thing. 🤖✨

---

💖 okay that's the whole page, bestie. Source/version footer vibes: Vector BLF, and the page title in that footer is Vector::BL...netRxError(3) — cute little sign-off, not a copy-paste. 🎀