Fapi_GetPollHandles(3)

🌸 NAME 🌸

Okay bestie, welcome to the Fapi_GetPollHandles(3) page from the Library Functions Manual β€” and yes, it's literally named Fapi_GetPollHandles - Fapi_GetPollHandles. Iconic naming, no notes. πŸ’…


✨ SYNOPSIS ✨

Functions

TSS2_RC Fapi_GetPollHandles (FAPI_CONTEXT *context, FAPI_POLL_HANDLE **handles, size_t *num_handles)

πŸ¦‹ DETAILED DESCRIPTION πŸ¦‹

This is the FAPI function for grabbing the poll handles that the corresponding FAPI_CONTEXT is currently using. Lowkey important, highkey useful. 🫢


πŸŽ€ FUNCTION DOCUMENTATION πŸŽ€

TSS2_RC Fapi_GetPollHandles (FAPI_CONTEXT * context, FAPI_POLL_HANDLE ** handles, size_t * num_handles)

Retrieve handles for polling

It returns an array of handles that you can poll on so you get notified when data from the TPM or from a disk operation is available. Slay. ✨

The corresponding code should look similar to follows:

do { r = Fapi_GetPollHandles(fc, &ph, &nph); if (r == TSS2_RC_SUCCESS) { poll(ph, nph, -1); Fapi_Free(ph); } r = Fapi_*_Finish(fc, ...); } while (r == TSS2_FAPI_RC_TRY_AGAIN);

Parameters

  • context β€” the FAPI_CONTEXT
  • handles β€” an array of poll handle entries
  • num_handles β€” the size of the array in handles

Return values

  • TSS2_RC_SUCCESS β€” if the function call was a success. πŸ’–
  • TSS2_FAPI_RC_BAD_REFERENCE β€” if context or data is NULL.
  • TSS2_FAPI_RC_BAD_CONTEXT β€” if context corruption is detected.
  • TSS2_FAPI_RC_BAD_SEQUENCE β€” if the context has no asynchronous operation pending.
  • TSS2_FAPI_RC_NO_HANDLE β€” if there are no handles to poll on.
  • TSS2_FAPI_RC_MEMORY β€” if the FAPI cannot allocate enough memory for internal operations or return parameters.

πŸ’œ AUTHOR πŸ’œ

Generated automatically by Doxygen for tpm2-tss from the source code.


Okay that's the whole page, mwah πŸ’‹ β€” signed off with the tpm2-tss Version 4.1.5 footer energy and the Fapi_GetPollHandles(3) page tag. Periodt. πŸŽ€

πŸ“¦ where this page comes from