Orrery Terrain · OrreryTerrainCore module · member function
Native::FJoinStreamWriter::
Read
ExperimentalThe next bytes of the stream, at most Capacity, copied out of the ready ring.
Declaration
size_t Read(uint8_t* Out, size_t Capacity);- 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
- One thread at a time (the game thread), after Prepare.
Description
With the save in memory and Produce never called, Read frames the stream itself as the ring runs dry, a frame at a time. With a store it never touches the store.
Parameters
| Name | Type | Default | Meaning |
|---|---|---|---|
Out | uint8_ | — | — |
Capacity | size_ | — | — |
Returns
Bytes written; 0 once the end frame is out, while nothing is ready, after ReadFailed, or before a successful Prepare.
Note.
One thread at a time (the game thread), after Prepare. Never waits on the store.