CmdRequestFences#

Fully qualified name: cupva::CmdRequestFences

Defined in cupva_host.hpp

class CmdRequestFences : public cupva::BaseCmd#

CmdRequestFences will cause the stream to create and output the fence during the submit call.

The fence will expire when all task submitted to the stream before this request are completed. Fence is invalid until this command is submitted to a Stream.

  • Maturity: GA

Public Functions

CmdRequestFences() noexcept#

Construct a new, uninitialized object.

This constructor allows declaring stl containers. Commands should be initialized before submitting to streams.

Usage considerations

  • Allowed context for the API call

    • Interrupt handler: No

    • Signal handler: No

    • Thread-safe: No

    • Re-entrant: No

    • Async/Sync: Sync

  • Required privileges: None

  • Allowed execution state

    • Initialization: Yes

    • Operational: Yes

    • Reinit/Deinit Preparation: Yes

  • Maturity: GA

Pre:

None

explicit CmdRequestFences(Fence &fence) noexcept#

Constructor.

Usage considerations

  • Allowed context for the API call

    • Interrupt handler: No

    • Signal handler: No

    • Thread-safe: No

    • Re-entrant: No

    • Async/Sync: Sync

  • Required privileges: None

  • Allowed execution state

    • Initialization: Yes

    • Operational: Yes

    • Reinit/Deinit Preparation: Yes

  • Maturity: GA

Parameters:

fence – The reference to the fence to be filled during submit call.

Pre:

None

CmdRequestFences(Fence *const fences, int32_t const count)#

Constructor.

Request a fence array to be filled out during submit call.

Usage considerations

  • Allowed context for the API call

    • Interrupt handler: No

    • Signal handler: No

    • Thread-safe: No

    • Re-entrant: No

    • Async/Sync: Sync

  • Required privileges: None

  • Allowed execution state

    • Initialization: Yes

    • Operational: Yes

    • Reinit/Deinit Preparation: Yes

  • Maturity: GA

Parameters:
  • fences – The pointer to the fence array.

  • count – The number of fences in the array.

Throws:

cupva::Exception(InvalidArgument) – if MAX_CMD_REQUEST_FENCES_ARRAY_SIZE < count <= 0

Pre:

None

~CmdRequestFences() noexcept#

Destroy the object.

Usage considerations

  • Allowed context for the API call

    • Interrupt handler: No

    • Signal handler: No

    • Thread-safe: No

    • Re-entrant: No

    • Async/Sync: Sync

  • Required privileges: None

  • Allowed execution state

    • Initialization: Yes

    • Operational: Yes

    • Reinit/Deinit Preparation: Yes

  • Maturity: GA

Pre:

None

CmdRequestFences(CmdRequestFences &&obj) noexcept#

Move constructor.

Usage considerations

  • Allowed context for the API call

    • Interrupt handler: No

    • Signal handler: No

    • Thread-safe: No

    • Re-entrant: No

    • Async/Sync: Sync

  • Required privileges: None

  • Allowed execution state

    • Initialization: Yes

    • Operational: Yes

    • Reinit/Deinit Preparation: Yes

  • Maturity: GA

Pre:

None

CmdRequestFences &operator=(CmdRequestFences &&obj) & noexcept#

Move assignment.

Usage considerations

  • Allowed context for the API call

    • Interrupt handler: No

    • Signal handler: No

    • Thread-safe: No

    • Re-entrant: No

    • Async/Sync: Sync

  • Required privileges: None

  • Allowed execution state

    • Initialization: Yes

    • Operational: Yes

    • Reinit/Deinit Preparation: Yes

  • Maturity: GA

Pre:

None

CmdRequestFences(CmdRequestFences const&) = delete#
CmdRequestFences &operator=(CmdRequestFences const&) & = delete#