PIF-POFバイナリ形式

E PIF-POFバイナリ形式

プラットフォームおよび言語に依存することなくオブジェクトをシリアライズするために使用されるPortable Object Format (POF)およびPortable Invocation Format (PIF)のバイナリ・ストリームを学習します。

この付録の内容は次のとおりです。

PIF-POFバイナリ形式の概要
Portable Object Format (POF)では、オブジェクト値の元のプラットフォーム/言語とは関係なく、それらが未知であっても、そのオブジェクト値をバイナリ・ストリームにエンコードできます。
ストリーム形式
PIF-POFストリーム形式はオクテットを基準としており、PIF-POFストリームはオクテット値のシーケンスです。
事前定義型のバイナリ形式
PIF-POFでサポートされる事前定義(固有)型IDのバイナリ形式について理解します。
ユーザー定義型のバイナリ形式
非固有の型はすべてユーザー定義型と呼ばれます。

PIF-POFバイナリ形式の概要

Portable Object Format (POF)では、オブジェクト値の元のプラットフォーム/言語とは関係なく、それらが未知であっても、そのオブジェクト値をバイナリ・ストリームにエンコードできます。Portable Invocation Format (PIF)を使用すると、メソッド呼出しをバイナリ・ストリームに同様にエンコードできます。これら2つの形式(PIF-POFと呼ばれます)は、共通のバイナリ・エンコード基盤から派生したものです。ここではバイナリ形式を参考のために記載してありますが、PIF-POF使用時の要件を示すものではありません。Portable Object Formatの使用を参照してください

親トピック: PIF-POFバイナリ形式

ストリーム形式

PIF-POFストリーム形式はオクテットを基準としており、PIF-POFストリームはオクテット値のシーケンスです。わかりやすくするために、このドキュメントでは、すべてのオクテットを0x00から0xFF (10進法で0から255)の範囲の無署名の8ビット整数値として扱います。(PIF-POFでは)無署名の8ビット整数値で表される特定のオクテット値が、常に同じ無署名の8ビット整数値として書き込まれたり読み込まれたりするため、バイト順序はまったく重要ではありません。

PIFストリームには呼出しが1つだけ格納されます。呼出しは、その呼出しの残りの部分の長さを表す整数値を格納する最初のPOFストリーム、その直後に続く、対話IDの整数値を格納するPOFストリーム、さらにその直後に続く、メッセージ・オブジェクトのユーザー定義型値を格納するPOFストリームで構成されます。残りの部分の長さは、対話IDとメッセージ・オブジェクトのエンコードに使用されるオクテットの合計数を示しており、それによって、呼出しの受信プロセスでその呼出しの受信完了を判別できるようになります。TCP/IPでは特定のIPアドレスに対して複数の論理ポート番号を割り当てられますが、それと同様に対話IDは、1つの接続を通じて多重化される複数の論理クライアントおよびサービスをサポートするために使用されます。メッセージ・オブジェクトは、特定の高水準の対話プロトコルによって定義されます。

1つのPOFストリームには値が1つだけ格納されます。この値には型IDが格納され、型IDが値を示さない場合は、その後に型IDによって形式が定義されたデータ構造が続きます。

この項には次のトピックが含まれます:

親トピック: PIF-POFバイナリ形式

整数値

ストリーム形式は、圧縮形式での整数値のエンコード機能に大きく依存します。Coherenceでは、この整数バイナリ形式をパック整数と呼んでいます。この形式は、最初のオクテットと1つ以上の後続オクテットが必要に応じて使用される、可変長形式です。

表E-1は、最初のオクテットの3つの領域を示しています。

表E-1 パック整数の最初のオクテットの各領域

領域マスク	説明
0x80	継続インジケータ
0x40	負のインジケータ
0x3F	整数値(6つのバイナリLSD)

表E-2は、後続オクテットの2つの領域を示しています。

表E-2 パック整数の後続オクテットの各領域

領域マスク	説明
0x80	継続インジケータ
0x7F	整数値(次の7つのバイナリLSD)

例E-1は、Coherenceでサポートされるオクテット・ストリームに対する32ビット整数値の書込みを示しています。

例E-1 オクテット・ストリームに対する32ビット整数値の書込み

public static void writeInt(DataOutput out, int n)
        throws IOException
    {
    int b = 0;
    if (n < 0)
        {
        b = 0x40;
        n = ~n;
        }
    b |= (byte) (n & 0x3F);
    n >>>= 6;
    while (n != 0)
        {
        b |= 0x80;
        out.writeByte(b);
        b = (n & 0x7F);
        n >>>= 7;
        }
    out.writeByte(b);
    }

例E-2は、Coherenceでサポートされるオクテット・ストリームからの32ビット整数値の読込みを示しています。

例E-2 オクテット・ストリームからの32ビット整数値の読込み

public static int readInt(DataInput in)
        throws IOException
    {
    int b = in.readUnsignedByte();
    int n = b & 0x3F;
    int cBits = 6;
    boolean fNeg = (b & 0x40) != 0;
    while ((b & 0x80) != 0)
        {
        b = in.readUnsignedByte();
        n |= ((b & 0x7F) << cBits);
        cBits += 7;
        }
    if (fNeg)
        {
        n = ~n;
        }
    return n;
    }

このドキュメントで使用される整数値で、明示的な型IDがない場合は、10進数-2³¹から2³¹-1の範囲の32ビット整数値と見なされます。

表E-3は、いくつかの整数値の例を示しています。

表E-3 型IDがない整数値のバイナリ形式

値	バイナリ形式
0	0x00
1	0x01
2	0x02
99	0xA301
9999	0x8F9C01
-1	0x40
-2	0x41
-99	0xE201
-9999	0xCE9C01

親トピック: ストリーム形式

型ID

型IDは、整数値としてバイナリ・ストリームにエンコードされます。ゼロ以上の型IDは、ユーザー定義型のIDです。ゼロ未満の型IDは、事前定義(固有)型のIDです。

表E-4は、事前定義型のIDのリストです。

表E-4 事前定義型のID

型ID	説明
-1 (0x40)	int16
-2 (0x41)	int32
-3 (0x42)	int64
-4 (0x43)	int128*
-5 (0x44)	float32
-6 (0x45)	float64
-7 (0x46)	float128*
-8 (0x47)	decimal32*
-9 (0x48)	decimal64*
-10 (0x49)	decimal128*
-11 (0x4A)	boolean
-12 (0x4B)	octet
-13 (0x4C)	octet-string
-14 (0x4D)	char
-15 (0x4E)	char-string
-16 (0x4F)	date
-17 (0x50)	year-month-interval*
-18 (0x51)	time
-19 (0x52)	time-interval*
-20 (0x53)	datetime
-21 (0x54)	day-time-interval*
-22 (0x55)	collection
-23 (0x56)	uniform-collection
-24 (0x57)	array
-25 (0x58)	uniform-array
-26 (0x59)	sparse-array
-27 (0x5A)	uniform-sparse-array
-28 (0x5B)	map
-29 (0x5C)	uniform-keys-map
-30 (0x5D)	uniform-map
-31 (0x5E)	identity
-32 (0x5F)	reference

-33以下の型IDは、型と値の組合せです。この形式は、通常使用される値のスペースを削減するために使用されます。

表E-5は、型と値を組み合せた型IDのリストです。

表E-5 型と値を組み合せた型ID

型ID	説明
-33 (0x60)	boolean:false
-34 (0x61)	boolean:true
-35 (0x62)	string:zero-length
-36 (0x63)	collection:empty
-37 (0x64)	reference:null
-38 (0x65)	floating-point:+infinity
-39 (0x66)	floating-point:-infinity
-40 (0x67)	floating-point:NaN
-41 (0x68)	int:-1
-42 (0x69)	int:0
-43 (0x6A)	int:1
-44 (0x6B)	int:2
-45 (0x6C)	int:3
-46 (0x6D)	int:4
-47 (0x6E)	int:5
-48 (0x6F)	int:6
-49 (0x70)	int:7
-50 (0x71)	int:8
-51 (0x72)	int:9
-52 (0x73)	int:10
-53 (0x74)	int:11
-54 (0x75)	int:12
-55 (0x76)	int:13
-56 (0x77)	int:14
-57 (0x78)	int:15
-58 (0x79)	int:16
-59 (0x7A)	int:17
-60 (0x7B)	int:18
-61 (0x7C)	int:19
-62 (0x7D)	int:20
-63 (0x7E)	int:21
-64 (0x7F)	int:22

親トピック: ストリーム形式

事前定義型のバイナリ形式

PIF-POFでサポートされる事前定義(固有)型IDのバイナリ形式を学習します。対象の型は、int、Decimal、Floating Point、Boolean、Octet、Octet String、Char、Char String、Date、Year-Month Interval、Time、Time Interval、Date-Time、Date-Time Interval、Collection、Array、Sparse Array、Key-Value Map (ディクショナリ)、IdentityおよびReferenceです。

この項には次のトピックが含まれます:

親トピック: PIF-POFバイナリ形式

Int

int16、int32、int64およびint128の4つの符号付き整数型がサポートされます。ストリーム内に整数型の型IDが存在する場合は、その直後に整数値が続きます。

この4つの符号付き整数型は、その型の最大値をサポートするために必要な長さのみが異なり、共通の2の補数バイナリ形式を使用します。ストリーム内では、int16、int32、int64またはint128のいずれかの型IDの後ろに整数値が続きます。整数値が、型でサポートされる範囲(int16は、-2¹⁵から2¹⁵-1、int32は、-2³¹から2³¹-1、int64は、-2⁶³から2⁶³-1、int128は-2¹²⁷から2¹²⁷-1)に含まれない場合、結果は未定義になり、ビット単位の切捨てまたは例外が発生することがあります。

さらに簡潔さを保つためにintの指定と値をシングル・バイトに結合する型IDがいくつかあります。その結果、それらの型IDに値が組み込まれるため、ストリーム内で型IDの後に整数値が続くことはなくなります。

表E-6は、これらの型IDを示しています。

表E-6 intデータ型と値を結合する型ID

値	int16	int32	int64	int128
0	0x69	0x69	0x69	0x69
1	0x6A	0x6A	0x6A	0x6A
2	0x6B	0x6B	0x6B	0x6B
99	0x40A301	0x41A301	0x42A301	0x43A301
9999	0x408F9C01	0x418F9C01	0x428F9C01	0x438F9C01
-1	0x68	0x68	0x68	0x68
-2	0x4041	0x4141	0x4241	0x4341
-99	0x40E201	0x41E201	0x42E201	0x43E201
-9999	0x40CE9C01	0x41CE9C01	0x42CE9C01	0x43CE9C01

対応するJavaデータ型は、short (int16)、int (int32)、long (int64)およびBigInteger (int128)です。BigIntegerは、非常に大きい値を表すことができるため、すべてのBigInteger値をint128形式でエンコードすることはできません。int128の範囲に含まれない値は基本的にサポートされないため、例外が発生します。それを避けるには、文字列エンコードなどの別のエンコードを使用します。

値	Octet
0 (0x00)	0x69
1 (0x01)	0x6A
2 (0x02)	0x6B
99 (0x63)	0x4B63
254 (0xFE)	0x4BFE
255 (0xFF)	0x68

値	コレクション形式	共通コレクション形式
値なし	0x63 (or 0x5500)	該当なし(n/a)
1	0x55016A	0x56410101
1,2,3	0x55036A6B6C	0x564103010203
1, "ok"	0x55026A4E026F6B	該当なし

値	配列形式	共通配列形式
値なし	0x63 (or 0x5700)	0x63(または0x584100)–この例は、Int32型の要素の場合を示しています。
1	0x57016A	0x58410101
1,2,3	0x57036A6B6C	0x584103010203
1, "ok"	0x57026A4E026F6B	該当なし

値	スパース配列形式	共通スパース配列形式
値なし	0x63 (or 0x590040)	0x63(または0x5A410040)–この例は、Int32型の要素の場合を示しています。
1	0x5901006A40	0x5A4101000140
1,2,3	0x5903006A016B026C40	0x5A410300010102020340
1,,,,5,,,,9	0x5909006A046E087240	0x5A410900010405080940
1,,,,"ok"	0x5905006A044E026F6B40	該当なし

値	バイナリ形式
値なし	0x63(または0x5B00)
1="ok"	0x5B016A4E026F6B
1="ok", 2="no"	0x5B026A4E026F6B6B4E026E6F

値	バイナリ形式
値なし	0x63(または0x5C4100)
1="ok"	0x5C4101014E026F6B
1="ok", 2="no"	0x5C4102014E026F6B024E026E6F

値	バイナリ形式
値なし	0x63(または0x5D414E00)
1="ok"	0x5D414E0101026F6B
1="ok", 2="no"	0x5D414E0201026F6B02026E6F

値	Char String形式
長さゼロ	0x62(または0x4E00)
"ok"	0x4E026F6B

値	バイナリ形式
Id #1	0x5F01
Id #350	0x5F9E05
null	0x60

PIF-POFバイナリ形式の概要

ストリーム形式

整数値

型ID

事前定義型のバイナリ形式

Int

整数型の強制変換

Decimal

Floating Point

Boolean

Octet

Octet String

Char

Char String

Date

Year-Month Interval

Time

Time Interval

Date-Time

日付および時間の型の強制変換

Day-Time Interval

Collections

Arrays

Sparse Arrays

Key-Value Maps (Dictionaries)

Identity

Reference

ユーザー定義型のバイナリ形式

ユーザー定義型のバージョニング