Epok Engine

PSYQO SDK

psyqo::MemoryCard::scheduleReadSector

Method · 1 overload

Declarations are extracted from the pinned headers. Examples and general guidance are generated sketches, not verified complete programs; consult the linked source and guides for the actual contract.

Method

--- TaskQueue schedulers ---------------------------------------------

Belongs to
psyqo::MemoryCard
Header
memory-card.hh
Overloads
1

Declaration

Declaration
TaskQueue::Task scheduleReadSector(Port port, uint16_t sector, void *buffer, Error *resultOut)

--- TaskQueue schedulers ---------------------------------------------

ParameterTypeMeaning
portPortNot documented; consult the linked header.
sectoruint16_tNot documented; consult the linked header.
buffervoid *Not documented; consult the linked header.
resultOutError *Not documented; consult the linked header.

Returns: TaskQueue::Task. Consult the linked header for its meaning.

Example sketch

C++ example
#include "psyqo/memory-card.hh"

// Assume these named values have been initialized with valid data:
// Port port
// uint16_t sector
// void * buffer
// Error * resultOut

psyqo::MemoryCard& object = /* obtain a valid instance */;

auto result = object.scheduleReadSector(port, sector, buffer, resultOut);

Trade-offs and warnings

Consult the linked header for this operation’s ownership, lifetime and failure behavior.

Declared in https://github.com/epokengine/nugget/blob/4a01183295182b8e7702c908e1efaaa8f4538ffd/psyqo/memory-card.hh:163

Related members