IceLink

"Frozen Mountain Software"

FMIceLinkCircularBuffer Class Reference

Inherits from	NSObject
Declared in	FMIceLinkCircularBuffer.h FMIceLinkCircularBuffer.m

Overview

A circular buffer.

`– available`

Gets the number of bytes available for reading.

- (int)available

Discussion

Gets the number of bytes available for reading.

Declared In

FMIceLinkCircularBuffer.h

`+ circularBufferWithLength:latency:`

Initializes a new instance of the FMIceLinkCircularBuffer class.

+ (FMIceLinkCircularBuffer *)circularBufferWithLength:(int)length latency:(int)latency

Parameters

`length`	The length.
`latency`	The latency.

Discussion

Initializes a new instance of the FMIceLinkCircularBuffer class.

Declared In

FMIceLinkCircularBuffer.h

`+ circularBufferWithLength:latency:littleEndian:`

Initializes a new instance of the FMIceLinkCircularBuffer class.

+ (FMIceLinkCircularBuffer *)circularBufferWithLength:(int)length latency:(int)latency littleEndian:(bool)littleEndian

Parameters

`length`	The length.
`latency`	The latency.
`littleEndian`	Whether the data is little-endian.

Discussion

Initializes a new instance of the FMIceLinkCircularBuffer class.

Declared In

FMIceLinkCircularBuffer.h

`– initWithLength:latency:`

Initializes a new instance of the FMIceLinkCircularBuffer class.

- (instancetype)initWithLength:(int)length latency:(int)latency

Parameters

`length`	The length.
`latency`	The latency.

Discussion

Initializes a new instance of the FMIceLinkCircularBuffer class.

Declared In

FMIceLinkCircularBuffer.h

`– initWithLength:latency:littleEndian:`

Initializes a new instance of the FMIceLinkCircularBuffer class.

- (instancetype)initWithLength:(int)length latency:(int)latency littleEndian:(bool)littleEndian

Parameters

`length`	The length.
`latency`	The latency.
`littleEndian`	Whether the data is little-endian.

Discussion

Initializes a new instance of the FMIceLinkCircularBuffer class.

Declared In

FMIceLinkCircularBuffer.h

`– latency`

Gets the latency.

- (int)latency

Discussion

Gets the latency.

Declared In

FMIceLinkCircularBuffer.h

`– length`

Gets the length.

- (int)length

Discussion

Gets the length.

Declared In

FMIceLinkCircularBuffer.h

`– littleEndian`

Gets whether the data is little-endian.

- (bool)littleEndian

Discussion

Gets whether the data is little-endian.

Declared In

FMIceLinkCircularBuffer.h

`– readOffset`

Gets the read offset.

- (int)readOffset

Discussion

Gets the read offset.

Declared In

FMIceLinkCircularBuffer.h

`– readWithLength:`

Reads data from the buffer.

- (FMIceLinkDataBuffer *)readWithLength:(int)length

Parameters

`length`	The number of bytes to read.

Discussion

Reads data from the buffer.

Declared In

FMIceLinkCircularBuffer.h

`– writeOffset`

Gets the read offset.

- (int)writeOffset

Discussion

Gets the read offset.

Declared In

FMIceLinkCircularBuffer.h

`– writeWithBuffer:`

Writes data to the buffer.

- (void)writeWithBuffer:(FMIceLinkDataBuffer *)buffer

Parameters

`buffer`	The data to write.

Discussion

Writes data to the buffer.

Declared In

FMIceLinkCircularBuffer.h