DCE-Eurobot: hokuyo/lib/ring_buffer.h File Reference

リングバッファ More...

This graph shows which files directly or indirectly include this file:

Classes
struct	ringBuffer_t
	リングバッファの管理情報 More...
Functions
void	ring_initialize (ringBuffer_t ring, char buffer, const int shift_length)
	初期化
void	ring_clear (ringBuffer_t *ring)
	リングバッファのクリア
int	ring_size (const ringBuffer_t *ring)
	格納データ数を返す
int	ring_capacity (const ringBuffer_t *ring)
	最大の格納データ数を返す
int	ring_write (ringBuffer_t ring, const char data, int size)
	データの格納
int	ring_read (ringBuffer_t ring, char buffer, int size)
	データの取り出し

Detailed Description

リングバッファ

Author:: Satofumi KAMIMURA

Id:: ring_buffer.h 1557 2009-12-01 12:38:06Z satofumi

Function Documentation

int ring_capacity ( const ringBuffer_t * ring )

最大の格納データ数を返す

Parameters:

[in] ring リングバッファの構造体

Here is the caller graph for this function:

void ring_clear ( ringBuffer_t * ring )

リングバッファのクリア

Parameters:

[in] ring リングバッファの構造体

Here is the caller graph for this function:

void ring_initialize	(	ringBuffer_t *	ring,
		char *	buffer,
		const int	shift_length
	)

初期化

Parameters:

`[in]`	ring	リングバッファの構造体
`[in]`	buffer	割り当てるバッファ
`[in]`	shift_length	バッファサイズの 2 の乗数

Here is the call graph for this function:

Here is the caller graph for this function:

int ring_read	(	ringBuffer_t *	ring,
		char *	buffer,
		int	size
	)

データの取り出し

Parameters:

`[in]`	ring	リングバッファの構造体
`[out]`	buffer	データ
`[in]`	size	最大のデータサイズ

Returns:: 取り出したデータ数

Here is the call graph for this function:

Here is the caller graph for this function:

int ring_size ( const ringBuffer_t * ring )

格納データ数を返す

Parameters:

[in] ring リングバッファの構造体

Here is the caller graph for this function:

int ring_write	(	ringBuffer_t *	ring,
		const char *	data,
		int	size
	)

データの格納

Parameters:

`[in]`	ring	リングバッファの構造体
`[in]`	data	データ
`[in]`	size	データサイズ

Returns:: 格納したデータ数

Here is the call graph for this function:

Here is the caller graph for this function: