FMIceLinkCircularDataBuffer Class Reference

Inherits from	FMIceLinkDataBuffer : NSObject
Declared in	FMIceLinkCircularDataBuffer.h FMIceLinkCircularDataBuffer.m

Overview

A DataBuffer that uses a circular buffer to manage [data](#//api/name/data).

`– appendDataBuffer:`

Appends a [data](#//api/name/data) buffer to the correct place in this circular [data](#//api/name/data) buffer.

- (void)appendDataBuffer:(FMIceLinkDataBuffer *)buffer

Parameters

`buffer`	The buffer to write.

Discussion

Appends a [data](#//api/name/data) buffer to the correct place in this circular [data](#//api/name/data) buffer.

Declared In

FMIceLinkCircularDataBuffer.h

`– beginWriteWithMaxWriteSize:`

Tells the CircularDataBuffer to expect more [data](#//api/name/data) of up to maxWriteSize. Will reshuffle [data](#//api/name/data) around or resize if necessary.

- (int)beginWriteWithMaxWriteSize:(int)maxWriteSize

Parameters

`maxWriteSize`	The amount of bytes to make available for writing.

Discussion

Tells the CircularDataBuffer to expect more [data](#//api/name/data) of up to maxWriteSize. Will reshuffle [data](#//api/name/data) around or resize if necessary.

Declared In

FMIceLinkCircularDataBuffer.h

`– capacity`

Gets the capacity of this CircularDataBuffer.

- (int)capacity

Discussion

Gets the capacity of this CircularDataBuffer.

Declared In

FMIceLinkCircularDataBuffer.h

`+ createWithInitialSize:`

Creates a new instance of the CircularDataBuffer that can hold a initial amount of [data](#//api/name/data).

+ (FMIceLinkCircularDataBuffer *)createWithInitialSize:(int)initialSize

Parameters

`initialSize`	The initial size of the inner buffer.

Discussion

Creates a new instance of the CircularDataBuffer that can hold a initial amount of [data](#//api/name/data).

Declared In

FMIceLinkCircularDataBuffer.h

`– data`

Gets the data.

- (NSMutableData *)data

Discussion

Gets the data.

Declared In

FMIceLinkCircularDataBuffer.h

`– discardWithAmount:`

Advances the Index by amount so the space used by the [data](#//api/name/data) can be reused.

- (void)discardWithAmount:(int)amount

Parameters

`amount`	The amount to advance the Index by.

Discussion

Advances the Index by amount so the space used by the [data](#//api/name/data) can be reused.

Declared In

FMIceLinkCircularDataBuffer.h

`– endWriteWithActuallyWrittenSize:`

Tells the CircularDataBuffer how much [data](#//api/name/data) was actually written so that the Length can be set appropriately.

- (void)endWriteWithActuallyWrittenSize:(int)actuallyWrittenSize

Parameters

`actuallyWrittenSize`	The amount of data actually written to the data buffer.

Discussion

Tells the CircularDataBuffer how much [data](#//api/name/data) was actually written so that the Length can be set appropriately.

Declared In

FMIceLinkCircularDataBuffer.h

`– free`

Frees the internal pooled DataBuffer.

- (void)free

Discussion

Frees the internal pooled DataBuffer.

Declared In

FMIceLinkCircularDataBuffer.h