Method GetAvailableCount

GetAvailableCount(ref ulong)

Computes the number of elements available to read from the buffer. The range is 0 through Capacity.

Declaration

public int GetAvailableCount(ref ulong readCount)

Parameters

Type	Name	Description
ulong	readCount	The total number of elements that have been read from the buffer.

Returns

Type	Description
int	The number of elements available to read in the buffer.

Remarks

The given readCount may be modified in two circumstances: either because the write count has been reset since the last call (in this case, the read count is reset to 0), or because there are more elements to read than the buffer capacity, in which case the read count is increased so that the number of available elements is equal to the capacity.