Skip to content
Brass Orrery

Orrery Terrain · OrreryTerrainCore module · member function

Native::FJoinStreamReader::

Drain

Experimental

Write every run that arrived and is not in the store yet to it, making the store first; returns once none is left, including runs that arrive meanwhile.

Declaration

bool Drain();
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, only after TakeDrain answered true, one call per true: a background task's work (disk).

Description

A written run leaves memory, unless the file keeps it for the load.

Returns

false once the store could not be made or written (Error then answers StoreFailed).

Note.

Any thread, only after TakeDrain answered true, one call per true: a background task's work (disk).