Struct MappedBufferVersionBlockWithSize

Namespace

rF2SharedMemoryNet.RF2Data.Structs

Assembly

rF2SharedMemoryNet.dll

Represents a version block with size information for a mapped buffer, used to track updates to the buffer.

public struct MappedBufferVersionBlockWithSize

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Remarks

This structure is typically used in scenarios where a mapped buffer requires versioning to ensure consistency during updates. The versioning mechanism involves incrementing the update counters before and after the buffer is written to, allowing consumers to detect changes.

Fields

BytesUpdatedHint

Represents the number of bytes written to the structure during the last update.

public int BytesUpdatedHint

Field Value

int

Remarks

This value provides a hint about the amount of data updated in the structure. It may be useful for tracking or debugging purposes. 0 Should be considered complete

VersionUpdateBegin

Represents the version number of the buffer at the point when an update begins.

public uint VersionUpdateBegin

Field Value

uint

Remarks

This value is incremented immediately before the buffer is written to, indicating the start of an update. It can be used to track changes or ensure consistency during buffer operations.

VersionUpdateEnd

Represents the version update counter that is incremented after a buffer write operation is completed.

public uint VersionUpdateEnd

Field Value

uint

Remarks

This field is used to track the completion of buffer write operations. It is incremented automatically after each write operation to indicate the end of the update process.