CTR-Pia  5.4.3
Game Communication Engine
 全て クラス ネームスペース 関数 変数 型定義 列挙型 列挙型の値 ページ
クラス nn::pia::common::SignatureSetting

署名の設定情報を保持するクラスです。 [詳細]

+ nn::pia::common::SignatureSettingに対する継承グラフ

Public 型

enum  Mode {
  Mode_Nothing = 0,
  Mode_HmacMd5
}
 署名アルゴリズムの種類を表します。 [詳細]
 

Public メソッド

 SignatureSetting (Mode mode, const void *cpKeyData, uint32_t keySize)
 コンストラクタです。署名アルゴリズムと鍵を指定して初期化します。
 
 SignatureSetting (const void *cpKeyData, uint32_t keySize)
 コンストラクタです。鍵を指定して既定のアルゴリズム(HMAC-MD5)で初期化します。
 
 SignatureSetting ()
 コンストラクタです。署名なしとして初期化します。
 
virtual ~SignatureSetting ()
 デストラクタです。
 
const void * GetKeyData () const
 指定されている鍵データのアドレスを取得します。
 
uint32_t GetKeySize () const
 指定されている鍵データのサイズを取得します。
 
Mode GetMode () const
 指定されている署名アルゴリズムを取得します。
 
Result Set (Mode mode, const void *cpKeyData, uint32_t keySize)
 署名の設定を指定します。
 

Static Public 変数

static const SignatureSetting NoSignature
 署名なしを表す署名設定クラスのインスタンスです。
 
static const uint32_t SignatureKeyDataSizeMax = 32
 署名に用いられる鍵データの最大バイト数です。
 

説明

署名の設定情報を保持するクラスです。

列挙型

署名アルゴリズムの種類を表します。

列挙型の値:
Mode_Nothing 

署名無し

Mode_HmacMd5 

HMAC-MD5 による署名

コンストラクタとデストラクタ

nn::pia::common::SignatureSetting::SignatureSetting ( Mode  mode,
const void *  cpKeyData,
uint32_t  keySize 
)

コンストラクタです。署名アルゴリズムと鍵を指定して初期化します。

引数
[in]mode署名アルゴリズムの種類を指定します。
[in]cpKeyData鍵データのアドレスを設定します。このインスタンスが無くなるか再設定されるまで、参照先のデータの寿命を維持する必要があります。
[in]keySize鍵データのサイズ(バイト数)を指定します。
nn::pia::common::SignatureSetting::SignatureSetting ( const void *  cpKeyData,
uint32_t  keySize 
)

コンストラクタです。鍵を指定して既定のアルゴリズム(HMAC-MD5)で初期化します。

引数
[in]cpKeyData鍵データのアドレスを設定します。このインスタンスが無くなるか再設定されるまで、参照先のデータの寿命を維持する必要があります。
[in]keySize鍵データのサイズ(バイト数)を指定します。

関数

const void* nn::pia::common::SignatureSetting::GetKeyData ( ) const
inline

指定されている鍵データのアドレスを取得します。

戻り値
指定されている鍵データのアドレスです。
uint32_t nn::pia::common::SignatureSetting::GetKeySize ( ) const
inline

指定されている鍵データのサイズを取得します。

戻り値
指定されている鍵データのサイズ(バイト数)です。
Mode nn::pia::common::SignatureSetting::GetMode ( ) const
inline

指定されている署名アルゴリズムを取得します。

戻り値
指定されている署名アルゴリズムです。
Result nn::pia::common::SignatureSetting::Set ( Mode  mode,
const void *  cpKeyData,
uint32_t  keySize 
)

署名の設定を指定します。

引数
[in]mode署名アルゴリズムの種類を指定します。
[in]cpKeyData鍵データのアドレスを設定します。このインスタンスが無くなるか再設定されるまで、参照先のデータの寿命を維持する必要があります。
[in]keySize鍵データのサイズ(バイト数)を指定します。
戻り値
正しく設定された場合、成功を表す Result が返されます。
返るエラーの一覧:
ResultInvalidArgument 引数の指定が不正です。プログラミングエラーです。このエラーが返らないようにソースコードを修正してください。