Skip to content
Brass Orrery

Orrery Terrain · OrreryTerrainCore module · member function

Native::FJoinStreamWriter::

Produce

Experimental

Frame the stream ahead of Read: frames go into the ready ring until it holds FJoinStreamConfig::ReadAheadBytes or the end frame is in.

Declaration

bool Produce();
Header
#include "Native/Net/NetJoin.h"
Module
PublicDependencyModuleNames.Add("OrreryTerrainCore"); in your module’s Build.cs.
Stability
Experimental: supported, may change in a minor version, with a changelog line.
Thread
Any thread, one call at a time (a second waits for the first), after Prepare.

Description

Each save frame's bytes are read from the store outside the ring's lock.

Returns

true while frames remain to be framed; false once the end frame is in the ring, after a failed store read (Status ReadFailed: the failed frame is never made, nor any after it), or before a successful Prepare.

Note.

Any thread, one call at a time (a second waits for the first), after Prepare. Disk with a file store: a background task's work. Allocation: one buffer a frame.