Ryo Iizuka / libMiMic

This is Webservice SDK for mbed. LPCXpresso1769/LPC1768/FRDM-K64F/LPC4088

Dependents:   MbedFileServer_1768MiniDK2 RedWireBridge IssueDebug_gcc MiMicRemoteMCU-for-Mbed ... more

Embed: (wiki syntax)

« Back to documentation index

NyLPC_cFifoBuffer.h File Reference
Data Structures | Typedefs | Functions

NyLPC_cFifoBuffer.h File Reference

このファイルは、NyLPC_cFifoBufferクラスを定義します。 More...

Go to the source code of this file.

Data Structures

struct  NyLPC_TcFifoBuffer
 NyLPC_TcFifoBufferクラスの構造体です。 More...

Typedefs

typedef struct NyLPC_TcFifoBuffer NyLPC_TcFifoBuffer_t
 クラス型を定義します。 NyLPC_cFifoBufferクラスは、固定長のメモリを、最大bit長のFIFOメモリーとして扱うためのラップクラスです。

Functions

void NyLPC_cFifoBuffer_initialize (NyLPC_TcFifoBuffer_t *i_inst, void *i_buf, NyLPC_TUInt16 i_buf_size)
 コンストラクタです。 i_instを、i_bufをラップするインスタンスとして初期化します。 i_bufは、finalizeを呼び出すまで、クラスが参照します。 インスタンスを削除するまでの間、維持してください。
void NyLPC_cFifoBuffer_push (NyLPC_TcFifoBuffer_t *i_inst, const void *i_data, NyLPC_TUInt16 i_data_len)
 この関数は、バッファの後方にデータをコピーして追記します。 十分なサイズがない場合、ASSERTします。 書込み可能な最大サイズは、getSpace関数で得ることが出来ます。
void * NyLPC_cFifoBuffer_prePush (NyLPC_TcFifoBuffer_t *i_inst, NyLPC_TUInt16 i_data_len)
 先にメモリ領域を確保して、そのアドレスを返します。
void NyLPC_cFifoBuffer_pop (NyLPC_TcFifoBuffer_t *i_inst, NyLPC_TUInt16 i_len)
 この関数は、バッファの先頭からデータを削除します。 十分なデータがない場合、ASSERTします。 この関数は、戻り値を返しません。getPtrで得たポインタからデータを読み込んだ後に、読み込んだデータをバッファから削除するために使います。
void * NyLPC_cFifoBuffer_getPtr (const NyLPC_TcFifoBuffer_t *i_inst)
 バッファの先頭ポインタを得ます。
NyLPC_TUInt16 NyLPC_cFifoBuffer_getLength (const NyLPC_TcFifoBuffer_t *i_inst)
 格納しているデータの長さを返します。 getPtrで得たポインタから読み出せるデータのサイズに相当します。
NyLPC_TUInt16 NyLPC_cFifoBuffer_getSpace (const NyLPC_TcFifoBuffer_t *i_inst)
 バッファの残量を計算して返します。 この値は、push関数で追記できるデータサイズと同じです。

Detailed Description

このファイルは、NyLPC_cFifoBufferクラスを定義します。

Definition in file NyLPC_cFifoBuffer.h.

Typedef Documentation

typedef struct NyLPC_TcFifoBuffer NyLPC_TcFifoBuffer_t

クラス型を定義します。 NyLPC_cFifoBufferクラスは、固定長のメモリを、最大bit長のFIFOメモリーとして扱うためのラップクラスです。

Definition at line 43 of file NyLPC_cFifoBuffer.h.

Function Documentation

NyLPC_TUInt16 NyLPC_cFifoBuffer_getLength ( const NyLPC_TcFifoBuffer_t *  i_inst )

格納しているデータの長さを返します。 getPtrで得たポインタから読み出せるデータのサイズに相当します。

Parameters:
i_inst操作するインスタンスのポインタ
Returns:
読み出せるデータの長さです。

Definition at line 85 of file NyLPC_cFifoBuffer.c.

void* NyLPC_cFifoBuffer_getPtr ( const NyLPC_TcFifoBuffer_t *  i_inst )

バッファの先頭ポインタを得ます。

Parameters:
i_inst操作するインスタンスのポインタ
Returns:
バッファの先頭ポインタを返します。値は、次回にpush/popをするまでの間有効です。

Definition at line 78 of file NyLPC_cFifoBuffer.c.

NyLPC_TUInt16 NyLPC_cFifoBuffer_getSpace ( const NyLPC_TcFifoBuffer_t *  i_inst )

バッファの残量を計算して返します。 この値は、push関数で追記できるデータサイズと同じです。

Parameters:
i_inst操作するインスタンスのポインタ
Returns:
バッファの空き領域のサイズです。

Definition at line 92 of file NyLPC_cFifoBuffer.c.

void NyLPC_cFifoBuffer_initialize ( NyLPC_TcFifoBuffer_t *  i_inst,
void *  i_buf,
NyLPC_TUInt16  i_buf_size 
)

コンストラクタです。 i_instを、i_bufをラップするインスタンスとして初期化します。 i_bufは、finalizeを呼び出すまで、クラスが参照します。 インスタンスを削除するまでの間、維持してください。

Parameters:
i_inst初期化するメモリブロックのアドレス。
i_bufラップするメモリブロックのアドレス
i_buf_sizei_bufのサイズ。

Definition at line 32 of file NyLPC_cFifoBuffer.c.

void NyLPC_cFifoBuffer_pop ( NyLPC_TcFifoBuffer_t *  i_inst,
NyLPC_TUInt16  i_len 
)

この関数は、バッファの先頭からデータを削除します。 十分なデータがない場合、ASSERTします。 この関数は、戻り値を返しません。getPtrで得たポインタからデータを読み込んだ後に、読み込んだデータをバッファから削除するために使います。

Parameters:
i_inst操作するインスタンスのポインタ
i_data削除するデータのサイズ。getLengthの戻り値以下である必要があります。

Definition at line 64 of file NyLPC_cFifoBuffer.c.

void* NyLPC_cFifoBuffer_prePush ( NyLPC_TcFifoBuffer_t *  i_inst,
NyLPC_TUInt16  i_data_len 
)

先にメモリ領域を確保して、そのアドレスを返します。

Definition at line 52 of file NyLPC_cFifoBuffer.c.

void NyLPC_cFifoBuffer_push ( NyLPC_TcFifoBuffer_t *  i_inst,
const void *  i_data,
NyLPC_TUInt16  i_data_len 
)

この関数は、バッファの後方にデータをコピーして追記します。 十分なサイズがない場合、ASSERTします。 書込み可能な最大サイズは、getSpace関数で得ることが出来ます。

Parameters:
i_inst操作するインスタンスのポインタ
i_data追記するデータ。
i_data_len追記するデータのサイズ

Definition at line 43 of file NyLPC_cFifoBuffer.c.

Generated on Tue Jul 12 2022 15:46:17 by  doxygen 1.7.2