VECTOR_BLF_ETHERNETFRAMEFORWARDED(3)

πŸ“¦ version 2.4.2, in arch rolling

πŸŽ€ NAME πŸŽ€

Vector::BLF::EthernetFrameForwarded β€” literally the ETHERNET_FRAME_FORWARDED situation, bestie. That's the whole vibe. (Oh and hey, this is page Vector::BLF::EthernetFrameForwarded(3) from the Library Functions Manual β€” welcome to the group chat πŸ’–)

✨ SYNOPSIS ✨

#include <EthernetFrameForwarded.h>

Inherits Vector::BLF::ObjectHeader. So yes, it's giving nepo-baby of ObjectHeader, but like, in the good way 🫢

🌸 Public Member Functions

  • void read (AbstractFile &is) override
  • void write (AbstractFile &os) override
  • uint32_t calculateObjectSize () const override
  • virtual uint16_t calculateStructLength () const

πŸ¦‹ Public Member Functions inherited from Vector::BLF::ObjectHeader

  • ObjectHeader (const ObjectType objectType, const uint16_t objectVersion=0)
  • void read (AbstractFile &is) override
  • void write (AbstractFile &os) override
  • uint16_t calculateHeaderSize () const override
  • uint32_t calculateObjectSize () const override

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

  • ObjectHeaderBase (const uint16_t headerVersion, const ObjectType objectType)
  • ObjectHeaderBase (const ObjectHeaderBase &)=default
  • ObjectHeaderBase & operator= (const ObjectHeaderBase &)=default
  • ObjectHeaderBase (ObjectHeaderBase &&)=default
  • ObjectHeaderBase & operator= (ObjectHeaderBase &&)=default

πŸ’œ Public Attributes

  • uint16_t structLength {} β€” the length of this structure, and listen: without sizeof(VBLObjectHeader), without the mStructLength member, and without the mFrameData member. It's a very picky length, okay 😭
  • uint16_t flags {} β€” flags, which indicates the valid fields πŸ‘€
  • uint16_t channel {} β€” application channel, i.e. Eth 1
  • uint16_t hardwareChannel {} β€” the HW channel
  • uint64_t frameDuration {} β€” transmission duration in [ns] (nanoseconds, bestie, not a vibe)
  • uint32_t frameChecksum {} β€” Ethernet checksum
  • uint16_t dir {} β€” direction flag: 0=Rx, 1=Tx, 2=TxRq
  • uint16_t frameLength {} β€” number of valid frameData bytes
  • uint16_t wait no β€” uint32_t frameHandle {} β€” handle which refer the corresponding EthernetFrameForwarded event πŸ‘‘
  • uint32_t reservedEthernetFrameForwarded {} β€” reserved
  • std::vector< uint8_t > frameData {} β€” max 1612 data bytes per frame. Contains Ethernet header + Ethernet payload. That's the whole sandwich πŸ₯ͺ

πŸ“ 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 }

πŸ’– DESCRIPTION πŸ’–

πŸ’« Detailed Description

ETHERNET_FRAME_FORWARDED.

Ethernet frame forwarded πŸ¦‹

Lowkey that's it. It said what it said. Periodt.


πŸ”₯ Member Function Documentation πŸ”₯

🌟 uint32_t Vector::BLF::EthernetFrameForwarded::calculateObjectSize () const

[override], [virtual]

Calculates the objectSize.

Returns β€” object size ✨

Reimplemented from Vector::BLF::ObjectHeaderBase.

🌟 uint16_t Vector::BLF::EthernetFrameForwarded::calculateStructLength () const

[virtual]

Calculates structLength.

Returns β€” struct length ✨

🌟 void Vector::BLF::EthernetFrameForwarded::read (AbstractFile & is)

[override], [virtual]

Read the data of this object.

Parameters β€” is input stream πŸ“₯

Reimplemented from Vector::BLF::ObjectHeaderBase.

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

flags, which indicates the valid fields:

  • Bit 0 β€” normal packet = 0, forwarded packet = 1
  • Bit 1 β€” hardwareChannel valid
  • Bit 2 β€” frameDuration valid
  • Bit 3 β€” frameChecksum valid
  • Bit 4 β€” frameHandle valid
Ngl bestie, memorize these bits. They're literally the vibe check for which fields are actually real πŸ‘€

🧚 uint32_t Vector::BLF::EthernetFrameForwarded::reservedEthernetFrameForwarded {}

reserved πŸ™ˆ


πŸ‘‘ Author πŸ‘‘

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


πŸŽ€ And that's the whole page, bestie β€” this footer is brought to you by Vector BLF, page Vector::BLF::EthernetFrameForwarded(3), auto-generated from source and stamped in the manual the good old-fashioned Doxygen way. Slay πŸ’…βœ¨πŸ«Ά

πŸ“¦ where this page comes from