sco_ipc_v1.block_read

Reads exactly size bytes of the block at offset. SCO_NOT_FOUND: never written. SCO_BAD_ARG: the writer’s snapshot has another size. SCO_FAILED: the writer kept it torn; retry.

Signature

sco_result (*)(sco_plugin *, uint64_t, uint64_t, void *, uint32_t)

Service and availability

Service index

Property	Value
Symbol	`sco_ipc_v1.block_read`
Record ID	`sco-ipc-v1-block-read`
Service	sco.ipc
Table	sco_ipc_v1
Version macro	SCO_IPC_VERSION_1_0
Packed table version	65536
Since / availability	`size >= 40`; 1.0
Complete member extent (x64 bytes)	40
Table size (x64 bytes)	80

Header source

Parameters and buffers

sco_result (*block_read)(sco_plugin* self, uint64_t channel, uint64_t offset, void* out, uint32_t size);
Reads exactly size bytes of the block at offset. SCO_NOT_FOUND: never written. SCO_BAD_ARG: the writer’s snapshot has another size. SCO_FAILED: the writer kept it torn; retry.

Results and failures

Absent table: query_service NOT_FOUND; stopped: UNAVAILABLE; invalid/released self: BAD_ARG; unknown/non-owned channel: NOT_FOUND; allocation exceptions: TOO_MANY. Additional failures/output state unspecified unless described in the buffer contract.

Absent capability

Absent table: query_service NOT_FOUND

Ownership

Host owns mapping/channel; data copied via host staging buffers. No allocation transfer except borrowed view, never free it.

Thread affinity

Any thread; per-channel lock during copy. Recursive reentrancy unspecified.

Callback context

unspecified

Reentrancy

unspecified

Cleanup and cancellation

No in-flight cancellation; close/ordinary unload/non-retained crash cleanup marks closed and unmaps channels. Retained-provider faults skip owner resource-release hooks and require restart; backing resources remain retained, not safe for cached calls.

Language mappings

Status labels are copied verbatim from the catalogue: direct is native access; typed-wrapper is wrapper-backed; restricted is a subset/adaptation; unsupported means no supported route is established. No status implies universal safety.

Language	Catalogue status	Source evidence / wrapper tokens
c	direct	include/sco_ipc.h `(*block_read)`
cpp	typed-wrapper	include/scosdk/ipc.hpp `return t_->block_read(self_, id_, offset, data.data(), static_cast<uint32_t>(data.size()));`
csharp	unsupported	docs/sdk-csharp.md `There are no C# wrappers for sco.ipc and sco.net yet`
lua	unsupported	docs/ipc.md `Lua plugins get no sco.ipc`

Examples

None identified in the catalogue; this is not proof none can exist.

Tests

ABI pins prove layout, not semantic behavior or a live game session.