sco_ipc_v1.ring_pop

Catalogue snapshot — development preview

SDK 2.3.0 · game pack 0.6.0 · source e616ed69d8f9f77b0f4827881c86d91e4a7d1689 Published release: sdk-v2.3.0 (immutable approved assets; this development preview is not an approved release). Source-backed inventory is not a runtime or in-game verification claim.

Takes the oldest record of the SCO_IPC_FROM_PEER ring at offset, with the size handshake: *inout_size holds out’s capacity on entry, the record’s size on return; with SCO_TOO_MANY the size needed, and the record stays queued (pass out NULL with *inout_size 0 to ask). out_type may be NULL. SCO_NOT_FOUND: empty, or no ring there. SCO_FAILED: the peer wrote something invalid.

Limitations / unestablished guarantees

• Recursive reentrancy unspecified.
• Additional failures/output state unspecified unless described in the buffer contract.

Signature

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

Service and availability

Service index

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

Header source

Parameters and buffers

sco_result (*ring_pop)(sco_plugin* self, uint64_t channel, uint64_t offset, uint32_t* out_type, void* out, uint32_t* inout_size);
Takes the oldest record of the SCO_IPC_FROM_PEER ring at offset, with the size handshake: *inout_size holds out’s capacity on entry, the record’s size on return; with SCO_TOO_MANY the size needed, and the record stays queued (pass out NULL with *inout_size 0 to ask). out_type may be NULL. SCO_NOT_FOUND: empty, or no ring there. SCO_FAILED: the peer wrote something invalid.

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 (*ring_pop)
cpp	typed-wrapper	include/scosdk/ipc.hpp const sco_result r = t_->ring_pop(self_, id_, offset, &type, size ? out.data() : nullptr, &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

• tests/abi_ipc.c
• tests/test_ipc.cpp
• tools/test.sh

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