20.6. Hot Rod プロトコル

magic

1 バイト

0xA0 = request

メッセージ ID

vLong

応答にコピーされるメッセージの ID。これにより、Hot336 クライアントが非同期的にプロトコルを実装できます。

Version

1 バイト

hotgitops サーバーバージョン。この場合、これは 10 です。

opcode

1 バイト

Request operation code:
0x01 = put(since 1.0)
0x03 = get(since 1.0)
0x05 = putIfAbsent(since 1.0)
0x07 = replace(since 1.0)
0x09 = replaceIfUnmodified(since 1.0)
0x0B = remove(since 1.0)
0x0 D = removeIfUnmodified(since 1.0)
0x0F = containsKey(since 1.0)
0x11 = getWithVersion(since 1.0)
0x13 = clear(since 1.0)
0x15 = stats(since 1.0)
0x17 = ping(since 1.0)
0x19 = bulkGet(since 1.2)
0x1B = getWithMetadata(since 1.2)
0x1D = bulkGetKeys(since 1.2)
0x1F = query(since 1.3)
0x21 = authMechList(since 2.0)
0x23 = auth(since 2.0)
0x25 = addClientListener(since 2.0)
0x27 = removeClientListener(since 2.0)
0x29 = size(since 2.0)
0x2B = exec(since 2.1)
0x2D = putAll(since 2.1)
0x2F = getAll(since 2.1)
0x31 = iterationStart(since 2.3)
0x33 = iterationNext(since 2.3)
0 x35 = iterationEnd(since 2.3)
0x37 = getStream（以降 2.6）
0x39 = putStream（2.6 以降）

キャッシュ名の長さ

vInt

キャッシュ名の長さ。渡された長さが 0（キャッシュ名なし）の場合、操作はデフォルトのキャッシュと対話します。

キャッシュ名

string

動作させるキャッシュの名前。この名前は、Red Hat Data Grid 設定ファイルの事前に定義されたキャッシュの名前と一致している必要があります。

Flags

vInt

システムに渡されるフラグを表す変数長番号。各フラグはビットで表されます。このフィールドは変数の長さとして送信されるため、バイトで最も大きなビットを使用して、より多くのバイトを読み取る必要があるかどうかを判断するため、このビットはフラグを表します。このモデルを使用すると、フラグを短いスペースに統合できます。各フラグの現在の値は以下の通りです。
0x0001 = force return previous value

クライアントのインテリジェンス

1 バイト

このバイトヒントは、クライアント機能のサーバーをヒントします。
0x01 = basic client（クラスターまたはハッシュ情報ではない）
0x02 = topology-aware クライアント、クラスター情報に関心のある 0x03 = hash-distribution-aware クライアント
0x03 = hash-distribution-aware クライアント（クラスターおよびハッシュ情報の両方に関心がある）

トポロジー ID

vInt

このフィールドは、クライアントの最後の既知のビューを表します。基本的なクライアントは、このフィールドには 0 のみを送信します。トポロジー対応または hash-distribution 対応のクライアントは、現在のビュー ID でサーバーから応答を受け取るまで 0 を送信します。その後、応答で新しいビュー ID を受け取るまで、ビュー ID を送信する必要があります。

トランザクションタイプ

1 バイト

これは、以下のよく知られたトランザクションタイプの 1 つが含まれる 1 バイトフィールドです（このバージョンのプロトコルでは、サポートされる唯一のトランザクションタイプは 0）。
0 = Non-transactional 呼び出し、またはクライアントはトランザクションをサポートしません。後続の TX_ID フィールドは省略されます。
1 = x/Open XA トランザクション ID(XID)。これはよく知られており、固定サイズの形式です。

トランザクション ID

バイト配列

この呼び出しに関連するトランザクションを一意に識別するバイトアレイ。その長さはトランザクションタイプにより決定されます。トランザクションタイプが 0 の場合は、トランザクション ID は存在しません。

magic

1 バイト

0xA1 = response

メッセージ ID

vLong

メッセージの ID。応答が送信されるリクエストと一致します。

opcode

1 バイト

response operation code:
0x02 = put(since 1.0)
0x04 = get(since 1.0)
0x06 = putIfAbsent(since 1.0)
0x08 = replace(since 1.0)
0x0A = replaceIfUnmodified(since 1.0)
0x0C = remove(since 1.0)
0x 0e = removeIfUnmodified(since 1.0)
0x10 = containsKey(since 1.0)
0x12 = getWithVersion(since 1.0)
0x14 = clear(since 1.0)
0x16 = stats(since 1.0)
0x18 = ping(since 1.0)
0x1A = bulkGet(since 1.0)
0x1C = getWithMetadata(since 1.2)
0x1E = bulkGetKeys(since 1.2)
0x20 = query(since 1.3)
0x22 = authMechList(since 2.0)
0x24 = auth(since 2.0)
0x26 = addClientListener(since 2.0)
0x28 = removeClientListener(since 2.0)
0x2A = size(since 2.0)
0x2C = exec(since 2.1)
0x2E = putAll(since 2.1)
0x30 = getAll(since 2.1)
0x32 = iterationStart(since 2.3)
0x34 = iterationNext(since 2.3)
0 x36 = iterationEnd(since 2.3)
0x38 = getStream(since 2.6)
0x3A = putStream(since 2.6)
0x50 = error(since 1.0)

ステータス

1 バイト

status of the response, possible values:
0x00 = No error
0x01 = Not put/removed/replaced
0x02 = Key does not exist
0x81 = Invalid magic or message id
0x82 = Unknown command
0x83 = Unknown version
0x84 = Request parsing error
0x85 = Server Error
0x86 = Command timed out

トポロジー変更マーカー

string

これは、応答の前にトポロジーの変更情報が含まれるかどうかを示すマーカーバイトです。トポロジーが変更されないと、このバイトの内容は 0 になります。トポロジーが変更されると、その内容は 1 になります。

トポロジー変更マーカーのある応答ヘッダー

variable

先のセクションを参照してください。

トポロジー ID

vInt

トポロジー ID

トポロジーの num サーバー

vInt

クラスター内で稼働している Hotでサーバーの数。これは、これらのノードの一部のみが HotTEMPLATES サーバーを実行している場合に、クラスター全体のサブセットになる可能性があります。

M1: ホスト/IP 長

vInt

Hotgitops クライアントがアクセスするために使用できる各クラスターメンバーのホスト名または IP アドレスの長さ。ここで変数の長さを使用すると、ホスト名、IPv4 アドレス、および IPv6 アドレスに対応できます。

M1: ホスト/IP アドレス

string

Hot336 クライアントがアクセスに使用できる個別のクラスターメンバーのホスト名または IP アドレスが含まれる文字列。

M1: ポート

2 バイト（未署名）

Hotgitops クライアントがこのクラスターメンバーとの通信に使用できるポート。

m2: ホスト/IP の長さ

vInt

m2: ホスト/IP アドレス

string

m2: ポート

2 バイト（未署名）

…​etc

トポロジー変更マーカーのある応答ヘッダー

variable

先のセクションを参照してください。

トポロジー ID

vInt

トポロジー ID

num Key Owners

2 バイト（未署名）

各 Red Hat Data Grid 分散キーのコピーをグローバルに設定した数

ハッシュ関数バージョン

1 バイト

使用中の特定のハッシュ関数を参照するハッシュ関数のバージョン。詳細は「 Hotgitops hash functions 」を参照してください。

ハッシュスペースサイズ

vInt

ハッシュコード生成に関連するすべてのモジュールの Red Hat Data Grid によって使用されるモジュール。キーに正しいハッシュ計算を適用するには、クライアントでこの情報が必要になる可能性があります。

トポロジーの num サーバー

vInt

クラスター内で稼働している Red Hat Data Grid Hotgitops サーバーの数。これは、これらのノードの一部のみが HotTEMPLATES サーバーを実行している場合に、クラスター全体のサブセットになる可能性があります。

M1: ホスト/IP 長

vInt

Hotgitops クライアントがアクセスするために使用できる各クラスターメンバーのホスト名または IP アドレスの長さ。ここで変数の長さを使用すると、ホスト名、IPv4 アドレス、および IPv6 アドレスに対応できます。

M1: ホスト/IP アドレス

string

Hot336 クライアントがアクセスに使用できる個別のクラスターメンバーのホスト名または IP アドレスが含まれる文字列。

M1: ポート

2 バイト（未署名）

Hotgitops クライアントがこのクラスターメンバーと組み合わせるために使用できるポート。

M1: Hashcode

4 バイト

ユーザーが CSA を適用しているクラスターメンバーがどのクラスターメンバーであるかをインデントできるクラスターメンバーのハッシュコードを表す 32 ビット整数。

m2: ホスト/IP の長さ

vInt

m2: ホスト/IP アドレス

string

m2: ポート

2 バイト（未署名）

m2: Hashcode

4 バイト

…​etc

ヘッダー

variable

要求ヘッダー

キーの長さ

vInt

キーの長さ。vint のサイズは最大 5 バイトで、理論では Integer.MAX_VALUE よりも大きな数値を生成することができます。ただし、Java では Integer.MAX_VALUE を超える単一のアレイを作成できないため、プロトコルは vint アレイの長さを Integer.MAX_VALUE に制限します。

キー

バイト配列

値が要求されているキーが含まれるバイトアレイ。

ヘッダー

variable

応答ヘッダー

応答のステータス

1 バイト

0x00 = success（キーの取得の場合）
0x02 = if key does not exist

値の長さ

vInt

成功した場合、値の長さ

値

バイト配列

成功した場合、要求された値。

ヘッダー

variable

応答ヘッダー

応答のステータス

1 バイト

0x00 = success（キーが削除された場合）
0x02 = if key does not exist

以前の値の長さ

vInt

以前の値フラグが要求で送信され、キーが削除されると、以前の値の長さが返されます。キーが存在しない場合は、値の長さは 0 になります。フラグが送信されていない場合、値の長さはありません。

以前の値

バイト配列

以前の値フラグが要求で送信され、キーが削除された場合、以前の値。

ヘッダー

variable

応答ヘッダー

応答のステータス

1 バイト

0x00 = success, if key exists
0x02 = if key does not exist

ヘッダー

variable

応答ヘッダー

応答のステータス

1 バイト

0x00 = success（キーの取得の場合）
0x02 = if key does not exist

エントリーバージョン

8 バイト

既存のエントリーの変更の一意の値。このプロトコルは、entry_version 値が連続して行われるという義務はありません。更新ごとにキーレベルで一意となる必要があります。

値の長さ

vInt

成功した場合、値の長さ

値

バイト配列

成功した場合、要求された値。

ヘッダー

variable

要求ヘッダー

エントリー数

vInt

サーバーが返す Red Hat Data Grid エントリーの最大数（entry == key + 関連付けられた値）。CacheLoader.load(int)をサポートするために必要です。0 の場合、すべてのエントリーが返されます（CacheLoader.loadAll（）に必要）。

ヘッダー

variable

応答ヘッダー

応答のステータス

1 バイト

0x00 = success, data follows

詳細表示

1 バイト

複数のエントリーをストリームから読み取る必要があるかどうかを表す 1 つのバイト。そのため、1 に設定すると、エントリーが後に続くことを意味しますが、0 に設定された場合はストリームの最後となり、他のエントリーは読み取られません。BulkGet の詳細は、こちらを参照してください。

キー 1 長

vInt

キーの長さ

キー 1

バイト配列

取得されるキー

値 1 の長さ

vInt

値の長さ

値 1

バイト配列

取得した値

詳細表示

1 バイト

キー 2 長

vInt

キー 2

バイト配列

値 2 の長さ

vInt

値 2

バイト配列

…​

ヘッダー

variable

要求ヘッダー

キーの長さ

vInt

キーの長さ。vint のサイズは最大 5 バイトで、理論では Integer.MAX_VALUE よりも大きな数値を生成することができます。ただし、Java では Integer.MAX_VALUE を超える単一のアレイを作成できないため、プロトコルは vint アレイの長さを Integer.MAX_VALUE に制限します。

キー

バイト配列

値が要求されているキーが含まれるバイトアレイ。

有効期間

vInt

エントリーの有効期間が許可される秒数。秒数が 30 日を超える場合、この秒数は UNIX 時間として扱われるため、1/1/1970 からの秒数を表します。0 に設定すると、ライフスパンは無制限になります。

最大 ID

vInt

キャッシュからエビクトされる前に、エントリーをアイドル状態でいられる秒数。0 の場合は、最大アイドル時間がありません。

値の長さ

vInt

値の長さ

値

byte-array

保存する値

ヘッダー

variable

応答ヘッダー

応答のステータス

1 バイト

0x00 = success（保存されている場合）

以前の値の長さ

vInt

以前の値フラグが要求で送信され、キーが配置されている場合、以前の値の長さが返されます。キーが存在しない場合は、値の長さは 0 になります。フラグが送信されていない場合、値の長さはありません。

以前の値

バイト配列

以前の値フラグが要求で送信され、キーが配置された場合、以前の値。

ヘッダー

variable

応答ヘッダー

応答のステータス

1 バイト

0x00 = success（保存された場合は
0x01 = if store does not exist）

以前の値の長さ

vInt

リクエストで以前の値フラグを強制的に返すと、前の値の長さが返されます。キーが存在しない場合は、値の長さは 0 になります。フラグが送信されていない場合、値の長さはありません。

以前の値

バイト配列

リクエストで以前の値フラグが送信され、キーが置き換えられた場合に、以前の値が返されます。

ヘッダー

variable

応答ヘッダー

応答のステータス

1 バイト

0x00 = success（保存された場合は
0x01 = if store was exist）

以前の値の長さ

vInt

リクエストで以前の値フラグを強制的に返すと、前の値の長さが返されます。キーが存在しない場合は、値の長さは 0 になります。フラグが送信されていない場合、値の長さはありません。

以前の値

バイト配列

リクエストで以前の値フラグが送信され、キーが置き換えられた場合に、以前の値が返されます。

ヘッダー

variable

要求ヘッダー

キーの長さ

vInt

キーの長さ。vint のサイズは最大 5 バイトで、理論では Integer.MAX_VALUE よりも大きな数値を生成することができます。ただし、Java では Integer.MAX_VALUE を超える単一のアレイを作成できないため、プロトコルは vint アレイの長さを Integer.MAX_VALUE に制限します。

キー

バイト配列

値が要求されているキーが含まれるバイトアレイ。

有効期間

vInt

エントリーの有効期間が許可される秒数。秒数が 30 日を超える場合、この秒数は UNIX 時間として扱われるため、1/1/1970 からの秒数を表します。0 に設定すると、ライフスパンは無制限になります。

最大 ID

vInt

キャッシュからエビクトされる前に、エントリーをアイドル状態でいられる秒数。0 の場合は、最大アイドル時間がありません。

エントリーバージョン

8 バイト

GetWithVersion 操作によって返される値を使用します。

値の長さ

vInt

値の長さ

値

byte-array

保存する値

ヘッダー

variable

応答ヘッダー

応答のステータス

1 バイト

0x00 = success, if replaced
0x01 = if replace because key was changed
0x02 = if replaced because because key does not exist because

以前の値の長さ

vInt

リクエストで以前の値フラグを強制的に返すと、前の値の長さが返されます。キーが存在しない場合は、値の長さは 0 になります。フラグが送信されていない場合、値の長さはありません。

以前の値

バイト配列

リクエストで以前の値フラグが送信され、キーが置き換えられた場合に、以前の値が返されます。

ヘッダー

variable

要求ヘッダー

キーの長さ

vInt

キーの長さ。vint のサイズは最大 5 バイトで、理論では Integer.MAX_VALUE よりも大きな数値を生成することができます。ただし、Java では Integer.MAX_VALUE を超える単一のアレイを作成できないため、プロトコルは vint アレイの長さを Integer.MAX_VALUE に制限します。

キー

バイト配列

値が要求されているキーが含まれるバイトアレイ。

エントリーバージョン

8 バイト

GetWithMetadata 操作によって返される値を使用します。

ヘッダー

variable

応答ヘッダー

応答のステータス

1 バイト

0x00 = success（削除されている場合）
0x01 = if remove did not occurred because key was changed
0x02 = if not removed because key does not exist

以前の値の長さ

vInt

リクエストで以前の値フラグを強制的に返すと、前の値の長さが返されます。キーが存在しない場合は、値の長さは 0 になります。フラグが送信されていない場合、値の長さはありません。

以前の値

バイト配列

以前の値フラグが要求で送信され、キーが削除された場合、以前の値。

ヘッダー

variable

要求ヘッダー

ヘッダー

variable

応答ヘッダー

応答のステータス

1 バイト

0x00 = success（消去されている場合）

ヘッダー

variable

要求ヘッダー

有効期間

vInt

提供されたエントリーが存続できる秒数。秒数が 30 日を超える場合、この秒数は UNIX 時間として扱われるため、1/1/1970 からの秒数を表します。0 に設定すると、ライフスパンは無制限になります。

最大 ID

vInt

キャッシュからエビクトされる前に、各エントリーをアイドル状態でいられる秒数。0 の場合は、最大アイドル時間がありません。

エントリー数

vInt

挿入されるエントリーの数

キー 1 長

vInt

キーの長さ

キー 1

バイト配列

取得されるキー

値 1 の長さ

vInt

値の長さ

値 1

バイト配列

取得した値

キー 2 長

vInt

キー 2

バイト配列

値 2 の長さ

vInt

値 2

バイト配列

…​ エントリー数に達するまで継続する

ヘッダー

variable

応答ヘッダー

応答のステータス

1 バイト

0x00 = success（すべてが配置されている場合）

ヘッダー

variable

要求ヘッダー

キー数

vInt

エントリーを検索するキーの数

キー 1 長

vInt

キーの長さ

キー 1

バイト配列

取得されるキー

キー 2 長

vInt

キー 2

バイト配列

…​ キー数に達するまで継続される

ヘッダー

variable

応答ヘッダー

応答のステータス

1 バイト

エントリー数

vInt

返されるエントリーの数

キー 1 長

vInt

キーの長さ

キー 1

バイト配列

取得されるキー

値 1 の長さ

vInt

値の長さ

値 1

バイト配列

取得した値

キー 2 長

vInt

キー 2

バイト配列

値 2 の長さ

vInt

値 2

バイト配列

…​ エントリー数に達するまで継続する

0x00 = success。get returned sucessfully

timeSinceStart

Hotgitops の開始からの秒数。

currentNumberOfEntries

「Hoting servers」サーバーに現在含まれるエントリーの数。

totalNumberOfEntries

Hotgitops サーバーに保存されているエントリーの数。

stores

put 操作の数。

retrievals

get 操作の数。

Hits

ヒット数。

misses

get misses の数。

removeHits

削除ヒット数。

removeMisses

削除のミスの数。

ヘッダー

variable

要求ヘッダー

ヘッダー

variable

応答ヘッダー

応答のステータス

1 バイト

0x00 = success（統計が取得された場合）

統計数

vInt

返された個々の統計の数。

名前 1 の長さ

vInt

名前付き統計の長さ。

Name 1

string

統計名が含まれる文字列。

値 1 の長さ

vInt

value フィールドの長さ。

値 1

string

統計値が含まれる文字列。

名前 2 の長さ

vInt

名前 2

string

値 2 の長さ

vInt

値 2

文字列

…​etc

ヘッダー

variable

要求ヘッダー

ヘッダー

variable

応答ヘッダー

応答のステータス

1 バイト

0x00 = success（エラーがない場合）

ヘッダー

variable

応答ヘッダー

応答のステータス

1 バイト

0x8x = エラー応答コード

エラーメッセージの長さ

vInt

エラーメッセージの長さ

エラーメッセージ

string

エラーメッセージ0x84 の場合、このエラーフィールドには Hot336 サーバーでサポートされる最新バージョンが含まれます。長さは合計本文の長さで定義されます。