SFBFIFO

IFIFO インターフェースのラッパークラスです。

#include <SFBFIFO.h.hpp>

class SFBFIFO : public SFBPort;

SFMTYPEDEFWRAPPER(SFBFIFO)

継承図

バージョン

BREW 2.0	BREW 2.1	BREW 3.1	BREW 4.0
×	×	○	○

参照

BREW API IFIFO

メンバ

パブリック関数
`SInt32`	Flush( `SInt32` buf ) FIFO からのバイトを消費します。データを消費する点でこれは SFBFIFO::Read 関数と同じですが、データのコピーは実行されません。
`SFCError`	GetBufSize( `UInt32Ptr` size ) 現在割り当てられているバッファサイズを取得します。
`SFCError`	GetBufUsed( `UInt32Ptr` count ) 現在読み取り可能なバイト数を取得します。
static `SFBFIFOSmp`	NewInstance( `SFCErrorPtr` exception = null ) SFBFIFO インスタンスを生成します。
static `SFBFIFOSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) SFBFIFO インスタンスを生成します。
`SFCError`	OpenEx( `ACharConstPtr` name , `UInt16` mode ) FIFO を読み取り / 書き込みのために開きます。
`SFCError`	OpenEx( `SFXAnsiStringConstRef` name , `UInt16` mode ) FIFO を読み取り / 書き込みのために開きます。
`Void`	ReadableEx( `SFXCallbackPtr` callback , `PFNNOTIFY` notify , `VoidPtr` data ) SFBFIFO::Read が AEEPORT_WAIT 以外のものを返した場合にコールされるコールバックをスケジュールします。
`SFCError`	SetBufSize( `UInt32` size ) 割り当てるバッファサイズを設定します。
`Void`	WriteableEx( `SFXCallbackPtr` callback , `PFNNOTIFY` notify , `VoidPtr` data ) SFBFIFO::Write が AEEPORT_WAIT 以外のものを返した場合にコールされるコールバックをスケジュールします。
`SFCError`	Close( `Void` ) (SFBPort から継承) 開いているポートを閉じる、または進行中の開く操作を停止します。
static `Bool`	Exhausted( `SInt32` code ) (SFBSource から継承) SFBSource、SFBPeek、または SFBGetLine がデータを処理し終えたかどうかを判定します。
`SFCError`	GetLastError( `Void` ) (SFBPort から継承) SFBPort で発生した最後のエラーを取得します。
`SFCError`	IOCtl( `SInt32` option , `UInt32` val ) (SFBPort から継承) SFBPort の動作 ( 構成の設定／取得など ) に対する制御を可能にします。
`SFCError`	Open( `ACharConstPtr` port ) (SFBPort から継承) 指定されたポートを開きます。
`SFCError`	Open( `SFXAnsiStringConstRef` port ) (SFBPort から継承) 指定されたポートを開きます。
`SFCError`	QueryInterface( `AEECLSID` clsid , `VoidHandle` handle ) (SFBQuery から継承) このオブジェクトからの別の API を問い合わせます。
`SFCError`	QueryInterface( `AEECLSID` clsid , `SFBBaseSmpPtr` handle ) (SFBQuery から継承) このオブジェクトからの別の API を問い合わせます。
`SFBBaseSmp`	QueryInterface( `AEECLSID` clsid ) (SFBQuery から継承) このオブジェクトからの別の API を問い合わせます。
`SInt32`	Read( `VoidPtr` buf , `SInt32` size ) (SFBSource から継承) 指定したバッファにソースストリームからのバイトをコピーします。
`SInt32`	Read( `SFXBufferPtr` buf ) (SFBSource から継承) 指定したバッファにソースストリームからのバイトをコピーします。
`Void`	Readable( `SFXCallbackPtr` callback ) (SFBSource から継承) SFBSource::Read 関数が ISOURCE_WAIT 以外のものを返した場合に呼び出されるコールバック関数を登録または登録解除します。
`Void`	Self( `AEECLSID` clsidReq , `SFBQuerySmpPtr` clone , `AEECLSID` clsidImp ) (SFBQuery から継承) オブジェクトを単一インターフェースで実装するときに使います。
`SFBQuerySmp`	Self( `AEECLSID` clsidReq , `AEECLSID` clsidImp ) (SFBQuery から継承) オブジェクトを単一インターフェースで実装するときに使います。
`SInt32`	Write( `ACharConstPtr` port , `SInt32` bufSize ) (SFBPort から継承) 指定されたバッファからのバイトをソースストリームにコピーします。
`SInt32`	Write( `SFXAnsiStringConstRef` buf ) (SFBPort から継承) 指定されたバッファからのバイトをソースストリームにコピーします。
`SInt32`	Write( `SFXBufferConstRef` buf ) (SFBPort から継承) 指定されたバッファからのバイトをソースストリームにコピーします。
`Void`	Writeable( `SFXCallbackPtr` callback ) (SFBPort から継承) SFBPort::Write が AEEPORT_WAIT 以外のものを返した場合にコールされるコールバックをスケジュールします。

プロテクト関数
static `SFBBaseSmp`	FactoryByCreate( `AEECLSID` id , `SFCErrorPtr` exception = null ) (SFBBase から継承) 指定したクラス ID のインターフェースのインスタンスを生成します。
static `SFBBaseSmp`	FactoryByQuery( `SFBQuerySmpConstRef` query , `AEECLSID` id , `SFCErrorPtr` exception = null ) (SFBBase から継承) 指定したクラス ID のインターフェースのインスタンスを指定した SFBQuery インスタンスを使用して生成します。

SFBFIFO::Flush

FIFO からのバイトを消費します。データを消費する点でこれは SFBFIFO::Read 関数と同じですが、データのコピーは実行されません。

[ public ]
SInt32 Flush(
    SInt32 buf   // フラッシュを行うバイト数
);

戻り値

正常終了した場合はフラッシュされたバイト数が戻ります。

参照

BREW API IFIFO_Flush | SFBSource::Read

SFBFIFO::GetBufSize

現在割り当てられているバッファサイズを取得します。

[ public ]
SFCError GetBufSize(
    UInt32Ptr size   // 割り当てられているバッファサイズを格納する UInt32 へのポインタ
);

戻り値

成功したとき: SFERR_NO_ERROR
FIFO が開いていないとき: SFERR_INVALID_STATE
size ポインタが無効のとき: SFERR_INVALID_MEMORY

参照

BREW API IFIFO_GetBufSize | SFBFIFO::SetBufSize

SFBFIFO::GetBufUsed

現在読み取り可能なバイト数を取得します。

[ public ]
SFCError GetBufUsed(
    UInt32Ptr count   // 現在読み取り可能なバイト数を格納する UInt32 へのポインタ
);

戻り値

成功したとき: SFERR_NO_ERROR
FIFO が開いていないとき: SFERR_INVALID_STATE
count ポインタが無効のとき: SFERR_INVALID_MEMORY

参照

BREW API IFIFO_GetBufUsed | SFBSource::Read

SFBFIFO::NewInstance

SFBFIFO インスタンスを生成します。

[ public, static ]
SFBFIFOSmp NewInstance(
    SFCErrorPtr exception = null   // エラー値
);

[ public, static ]
SFBFIFOSmp NewInstance(
    AEECLSID id                    // クラスID
    SFCErrorPtr exception = null   // エラー値
);

SFBFIFO::OpenEx

FIFO を読み取り / 書き込みのために開きます。

[ public ]
SFCError OpenEx(
    ACharConstPtr name   // null 終結の FIFO 名
    UInt16 mode          // AEEFIFO_MODE_R または AEEFIFO_MODE_W 
);

[ public ]
SFCError OpenEx(
    SFXAnsiStringConstRef name   // FIFO 名
    UInt16 mode                  // AEEFIFO_MODE_R または AEEFIFO_MODE_W 
);

戻り値

成功したとき: SFERR_NO_ERROR
引数が不正なとき: SFERR_INVALID_PARAM
メモリ不足のとき: SFERR_NO_MEMORY
FIFO が開いていないとき: SFERR_INVALID_STATE
name ポインタが無効のとき: SFERR_INVALID_MEMORY
特権を持っていないとき: EPRIVLEVEL

参照

BREW API IFIFO_OpenEx | SFBPort::Open | SFBPort::Close

SFBFIFO::ReadableEx

SFBFIFO::Read が AEEPORT_WAIT 以外のものを返した場合にコールされるコールバックをスケジュールします。

[ public ]
Void ReadableEx(
    SFXCallbackPtr callback   // コールバック関数へのポインタ
    PFNNOTIFY notify          // ユーザーコールバック関数のポインタ
    VoidPtr data              // notify() をコールするときに使用するユーザーデータ
);

参照

BREW API IFIFO_ReadableEx | PFNNOTIFY | SFBSource::Read | SFBSource::Readable

SFBFIFO::SetBufSize

割り当てるバッファサイズを設定します。

[ public ]
SFCError SetBufSize(
    UInt32 size   // 希望のバッファサイズ
);

戻り値

成功したとき: SFERR_NO_ERROR
引数が不正なとき: SFERR_INVALID_PARAM
FIFO が開いていないとき: SFERR_INVALID_STATE
FIFO が書き込み用に開いていないとき : EPRIVLEVEL

参照

BREW API IFIFO_SetBufSize | SFBFIFO::SetBufSize

SFBFIFO::WriteableEx

SFBFIFO::Write が AEEPORT_WAIT 以外のものを返した場合にコールされるコールバックをスケジュールします。

[ public ]
Void WriteableEx(
    SFXCallbackPtr callback   // コールバック関数へのポインタ
    PFNNOTIFY notify          // ユーザーコールバック関数のポインタ
    VoidPtr data              // notify() をコールするときに使用するユーザーデータ
);

参照

BREW API IFIFO_WriteableEx | PFNNOTIFY | SFBPort::Write | SFBPort::Writeable