Vector::BL...netFrameEx(3)

💖 Vector::BLF::EthernetFrameEx 💖

okay so bestie, this is Vector::BL...netFrameEx(3), a Library Functions Manual page for the Vector::BLF::EthernetFrameEx class — and she is giving major iconic ETHERNET_FRAME_EX energy. Inherits Vector::BLF::ObjectHeader, periodt. We’re gonna go through every single inherited member too, because lore matters. 🫶

✨ NAME ✨

Vector::BLF::EthernetFrameEx — ETHERNET_FRAME_EX. That’s the name, that’s the vibe, that’s the whole point. 💅

🦋 SYNOPSIS 🦋

#include <EthernetFrameEx.h>

Inherits Vector::BLF::ObjectHeader.

🌸 Public Member Functions 🌸

• void read (AbstractFile &is) override — reads this object’s data from an AbstractFile & named is; it’s an override, so she’s doing her inherited duty. 💖
• void write (AbstractFile &os) override — writes this object’s data to an AbstractFile & named os; also an override, also slaying.
• uint32_t calculateObjectSize () const override — calculates the object size and gives you back a uint32_t. Override behavior, no cap.
• virtual uint16_t calculateStructLength () const — virtual function that calculates the struct length and returns a uint16_t. Cute and virtual.

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

• ObjectHeader (const ObjectType objectType, const uint16_t objectVersion=0) — constructor that takes an ObjectType objectType and a const uint16_t objectVersion=0. Yes, the default is 0, bestie.
• void read (AbstractFile &is) override — inherited read override, input stream is.
• void write (AbstractFile &os) override — inherited write override, output stream os.
• uint16_t calculateHeaderSize () const override — inherited override that calculates the header size, returning uint16_t.
• uint32_t calculateObjectSize () const override — inherited override that calculates the object size, returning uint32_t.

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

• ObjectHeaderBase (const uint16_t headerVersion, const ObjectType objectType) — constructor taking const uint16_t headerVersion and const ObjectType objectType.
• 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, without sizeof(VBLObjectHeader), without mStructLength member and without mFrameData member. Very specific, very demure.
• uint16_t flags {} — flags, which indicates the valid fields: (the full bit-by-bit tea is down in Member Data Documentation, keep scrolling bestie).
• uint16_t channel {} — application channel, i.e. Eth 1.
• uint16_t hardwareChannel {} — HW channel.
• uint64_t frameDuration {} — Transmission duration in [ns].
• uint32_t frameChecksum {} — Ethernet checksum.
• uint16_t dir {} — Direction flag: 0=Rx, 1=Tx, 2=TxRq.
• uint16_t frameLength {} — Number of valid frameData bytes.
• uint32_t frameHandle {} — Handle which refer the corresponding EthernetFrameForwarded event.
• uint32_t reservedEthernetFrameEx {} — reserved. That’s it, literally.
• std::vector< uint8_t > frameData {} — Max 1612 data bytes per frame. Contains Ethernet header + Ethernet payload.

💜 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.

🧚 Additional Inherited Members 🧚

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

• enum ObjectFlags : uint32_t { TimeTenMics = 0x00000001, TimeOneNans = 0x00000002 } — the enum, exactly as written. TimeTenMics is 0x00000001, TimeOneNans is 0x00000002, and yes those are hex values, don’t @ me.

🔥 Detailed Description 🔥

ETHERNET_FRAME_EX.

Ethernet frame2.

That’s the whole detailed description, bestie. Short. Iconic. Leaves you wanting more. 💀

💀 Member Function Documentation 💀

uint32_t Vector::BLF::EthernetFrameEx::calculateObjectSize () const

[override], [virtual]

Calculates the objectSize.

Returns: object size.

Reimplemented from Vector::BLF::ObjectHeaderBase.

uint16_t Vector::BLF::EthernetFrameEx::calculateStructLength () const

[virtual]

Calculates structLength.

Returns: struct length.

void Vector::BLF::EthernetFrameEx::read (AbstractFile & is)

[override], [virtual]

Read the data of this object.

Parameters: is — input stream.

Reimplemented from Vector::BLF::ObjectHeaderBase.

void Vector::BLF::EthernetFrameEx::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::EthernetFrameEx::flags {}

flags, which indicates the valid fields:

• Bit 0 - normal packet = 0, forwarded packet = 1
• Bit 1 - mHardwareChannel valid
• Bit 2 - mFrameDuration valid
• Bit 3 - mFrameChecksum valid
• Bit 4 - mFrameHandle valid

uint32_t Vector::BLF::EthernetFrameEx::reservedEthernetFrameEx {}

reserved.

🌟 Author 🌟

Generated automatically by Doxygen for Vector BLF from the source code.

---

okay final sign-off bestie: source/version is Vector BLF, the footer page label is Vector::BL...netFrameEx(3), and there is no date printed in this footer — so that’s the whole tea. Bye, slay, hydrate, and don’t forget your inherited members 💅✨🫶