rte_tm_driver.h(3)

πŸ’– rte_tm_driver.h β€” Library Functions Manual πŸ’–

okay bestie, welcome to rte_tm_driver.h, a lil header from the DPDK crew 🫢 it's a Library Functions Manual page and it's giving "internals only, do not perceive me." stay with me, it's short and cute.


✨ NAME ✨

rte_tm_driver.h β€” literally just the header itself, that's the whole name, no notes πŸ’…


🌸 SYNOPSIS 🌸

#include <stdint.h>
#include <rte_errno.h>
#include 'rte_ethdev.h'
#include 'ethdev_driver.h'
#include 'rte_tm.h'

πŸŽ€ Functions πŸŽ€

static int rte_tm_error_set (struct rte_tm_error *error, int code, enum
    rte_tm_error_type type, const void *cause, const char *message)
const struct rte_tm_ops * rte_tm_ops_get (uint16_t port_id, struct
    rte_tm_error *error)

πŸ¦‹ Detailed Description πŸ¦‹

RTE Generic Traffic Manager API (Driver Side) ✨

so like, this file hands out implementation helpers for internal use by PMDs. it is not meant to be exposed to applications, and it is not subject to ABI versioning. read that again bestie β€” no ABI promises here, none, zero, periodt. πŸ™ˆ

Definition in file rte_tm_driver.h.


πŸ‘‘ Function Documentation πŸ‘‘

πŸ’œ int rte_tm_error_set (struct rte_tm_error * error, int code, enum rte_tm_error_type type, const void * cause, const char * message)

[inline], [static] β€” yes queen, both.

Initialize generic error structure. πŸ› οΈ

this function also sets rte_errno to a given value. the way it just does that, iconic.

Parameters

  • error β€” Pointer to error structure (may be NULL). yes, NULL is allowed, no judgement 🌈
  • code β€” Related error code (rte_errno).
  • type β€” Cause field and error type.
  • cause β€” Object responsible for the error. we found the culprit πŸ”
  • message β€” Human-readable error message.

Returns

Error code.

Definition at line 314 of file rte_tm_driver.h.


πŸ’œ const struct rte_tm_ops * rte_tm_ops_get (uint16_t port_id, struct rte_tm_error * error)

Get generic traffic manager operations structure from a port πŸŽ€

Parameters

  • port_id β€” The port identifier of the Ethernet device.
  • error β€” Error details.

Returns

The traffic manager operations structure associated with port_id on success, NULL otherwise. so if you get NULL... that's a no from the port, bestie 😭


🌟 Author 🌟

Generated automatically by Doxygen for DPDK from the source code. πŸ€–βœ¨


lowkey a warning for you: these helpers are internal PMD stuff, not for applications, and there's no ABI versioning protecting you. fr fr, don't build your app on them and then act surprised. πŸ’€

and that's the whole page, you ate it πŸ“ this was DPDK, Version 25.11.3, and the page is rte_tm_driver.h(3). mwah, go forth and manage your traffic πŸ’–πŸ¦‹πŸŽ€

πŸ“¦ where this page comes from