SFBRAMCache

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

#include <SFBRAMCache.h.hpp>

class SFBRAMCache : public SFBBase;

SFMTYPEDEFWRAPPER(SFBRAMCache)

継承図

バージョン

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

参照

BREW API IRamCache

メンバ

パブリック関数
`SFCError`	Add( `ACharConstPtr` key , `SInt32` keyLen , `ACharConstPtr` value , `SInt32` valueLen ) キャッシュにレコードを追加します。
`SFCError`	Add( `SFXAnsiStringConstRef` key , `SFXAnsiStringConstRef` value ) キャッシュにレコードを追加します。
`SFCError`	Find( `ACharConstPtr` key , `SInt32` keyLen , `ACharPtr` value , `SInt32Ptr` valueLen ) キャッシュ内でレコードを検索します。
`SFCError`	Find( `SFXAnsiStringConstRef` key , `SFXAnsiStringPtr` value ) キャッシュ内でレコードを検索します。
`SFCError`	FlushAll( `Void` ) キャッシュを空にします。すべてのレコードが削除されます。
`SFCError`	FlushExpired( `Void` ) キャッシュ内の満了チェックを行い、満了したレコードをすべて削除します。
static `SFBRAMCacheSmp`	NewInstance( `SFCErrorPtr` exception = null ) SFBRAMCache インスタンスを生成します。
static `SFBRAMCacheSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) SFBRAMCache インスタンスを生成します。
`SFCError`	Remove( `ACharConstPtr` key , `SInt32` keyLen ) キャッシュからレコードを削除します。
`SFCError`	Remove( `SFXAnsiStringConstRef` key ) キャッシュからレコードを削除します。
`SInt32`	SetMaxEntries( `SInt32` num ) キャッシュ内に許可される最大エントリ数を設定します。
`SInt32`	SetMaxSize( `SInt32` size ) キーと値を格納するために RamCache が消費できる最大サイズ( バイト数 )を設定します。
`UInt32`	SetTTL( `UInt32` ttl ) キャッシュ内のレコードの TTL ( ミリ秒 )を設定します。

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

SFBRAMCache::Add

キャッシュにレコードを追加します。

[ public ]
SFCError Add(
    ACharConstPtr key     // キーデータ
    SInt32 keyLen         // キーデータの長さ
    ACharConstPtr value   // 値データ
    SInt32 valueLen       // 値データの長さ
);

[ public ]
SFCError Add(
    SFXAnsiStringConstRef key     // キーデータ
    SFXAnsiStringConstRef value   // 値データ
);

戻り値

成功したとき: SFERR_NO_ERROR
メモリ不足のとき: SFERR_NO_MEMORY
失敗したとき: SFERR_FAILED

参照

BREW API IRAMCACHE_Add

SFBRAMCache::Find

キャッシュ内でレコードを検索します。

[ public ]
SFCError Find(
    ACharConstPtr key    // キーデータ
    SInt32 keyLen        // キーデータの長さ
    ACharPtr value       // 値データ
    SInt32Ptr valueLen   // value が非 null の場合は value のサイズ
                         // valueLen は入力として無効になる
                         // 出力時には、キャッシュ内のデータのサイズが格納される( ある場合 )
);

[ public ]
SFCError Find(
    SFXAnsiStringConstRef key   // キーデータ
    SFXAnsiStringPtr value      // 値データ
);

戻り値

成功したとき: SFERR_NO_ERROR
value が null のとき: SFERR_INVALID_PARAM
失敗したとき: SFERR_FAILED

参照

BREW API IRAMCACHE_Find

SFBRAMCache::FlushAll

キャッシュを空にします。すべてのレコードが削除されます。

[ public ]
SFCError FlushAll(Void);

戻り値

SFERR_NO_ERROR を返します。

参照

BREW API IRAMCACHE_FlushAll

SFBRAMCache::FlushExpired

キャッシュ内の満了チェックを行い、満了したレコードをすべて削除します。

[ public ]
SFCError FlushExpired(Void);

戻り値

SFERR_NO_ERROR を返します。

参照

BREW API IRAMCACHE_FlushExpired

SFBRAMCache::NewInstance

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

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

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

SFBRAMCache::Remove

キャッシュからレコードを削除します。

[ public ]
SFCError Remove(
    ACharConstPtr key   // キーデータ
    SInt32 keyLen       // キーデータの長さ
);

[ public ]
SFCError Remove(
    SFXAnsiStringConstRef key   // キーデータ
);

戻り値

成功したとき: SFERR_NO_ERROR
失敗したとき: SFERR_FAILED

参照

BREW API IRAMCACHE_Remove

SFBRAMCache::SetMaxEntries

キャッシュ内に許可される最大エントリ数を設定します。

[ public ]
SInt32 SetMaxEntries(
    SInt32 num   // 新しいエントリ数制限
);

参照

BREW API IRAMCACHE_SetMaxEntries

SFBRAMCache::SetMaxSize

キーと値を格納するために RamCache が消費できる最大サイズ( バイト数 )を設定します。

[ public ]
SInt32 SetMaxSize(
    SInt32 size   // 新しいサイズ( バイト数 )
);

参照

BREW API IRAMCACHE_SetMaxSize

SFBRAMCache::SetTTL

キャッシュ内のレコードの TTL ( ミリ秒 )を設定します。

[ public ]
UInt32 SetTTL(
    UInt32 ttl   // 新しい TTL ( ミリ秒 )
);

参照

BREW API IRAMCACHE_SetTTL