Method ReleasePayloadBufferDeferred

ReleasePayloadBufferDeferred(PayloadHandle)

Releases the Payload memory allocated within the default Payload container after two (system is double buffered) Update()> calls

Declaration

public void ReleasePayloadBufferDeferred(PayloadHandle handle)

Parameters

Type	Name	Description
PayloadHandle	handle	The PayloadHandle referencing the Payload buffer to release.

Remarks

This call adds payload handle to 'deferred' list, so it can be released after everything that uses this payload was processed. General use case is 'decoration' for logging messages. Some messages can be decorated with this payloads. Then Decorator is released, ReleasePayloadBufferDeferred is called and that guarantees that this decoration won't be attached to any log from this point. And then after two Update()> calls when all users of this Payload were processed - we should safely release it. For more details see ReleasePayloadBuffer(PayloadHandle, out PayloadReleaseResult, bool)