PackStream (Neo4j - Bolt Protocol Version 1 3.3.0-alpha05 API)

java.lang.Object
- org.neo4j.bolt.v1.packstream.PackStream

public class PackStream
extends Object

PackStream is a messaging serialisation format heavily inspired by MessagePack. The key differences are in the type system itself which (among other things) replaces extensions with structures. The Packer and Unpacker implementations are also faster than their MessagePack counterparts.

Note that several marker byte values are RESERVED for future use. Extra markers should not be added casually and such additions must be follow a strict process involving both client and server software.

The table below shows all allocated marker byte values.

Marker	Binary	Type	Description
`00..7F`	`0xxxxxxx`	+TINY_INT	Integer 0 to 127
`80..8F`	`1000xxxx`	TINY_STRING
`90..9F`	`1001xxxx`	TINY_LIST
`A0..AF`	`1010xxxx`	TINY_MAP
`B0..BF`	`1011xxxx`	TINY_STRUCT
`C0`	`11000000`	NULL
`C1`	`11000001`	FLOAT_64	64-bit floating point number (double)
`C2`	`11000010`	FALSE	Boolean false
`C3`	`11000011`	TRUE	Boolean true
`C4..C7`	`110001xx`	RESERVED
`C8`	`11001000`	INT_8	8-bit signed integer
`C9`	`11001001`	INT_8	16-bit signed integer
`CA`	`11001010`	INT_8	32-bit signed integer
`CB`	`11001011`	INT_8	64-bit signed integer
`CC`	`11001100`	BYTES_8	Byte string (fewer than 2⁸ bytes)
`CD`	`11001101`	BYTES_16	Byte string (fewer than 2¹⁶ bytes)
`CE`	`11001110`	BYTES_32	Byte string (fewer than 2³² bytes)
`CF`	`11001111`	RESERVED
`D0`	`11010000`	STRING_8	UTF-8 encoded string (fewer than 2⁸ bytes)
`D1`	`11010001`	STRING_16	UTF-8 encoded string (fewer than 2¹⁶ bytes)
`D2`	`11010010`	STRING_32	UTF-8 encoded string (fewer than 2³² bytes)
`D3`	`11010011`	RESERVED
`D4`	`11010100`	LIST_8	List (fewer than 2⁸ items)
`D5`	`11010101`	LIST_16	List (fewer than 2¹⁶ items)
`D6`	`11010110`	LIST_32	List (fewer than 2³² items)
`D7`	`11010111`	RESERVED
`D8`	`11011000`	MAP_8	Map (fewer than 2⁸ key:value pairs)
`D9`	`11011001`	MAP_16	Map (fewer than 2¹⁶ key:value pairs)
`DA`	`11011010`	MAP_32	Map (fewer than 2³² key:value pairs)
`DB`	`11011011`	RESERVED
`DC`	`11011100`	STRUCT_8	Structure (fewer than 2⁸ fields)
`DD`	`11011101`	STRUCT_16	Structure (fewer than 2¹⁶ fields)
`DE`	`11011110`	STRUCT_32	Structure (fewer than 2³² fields)
`DF`	`11011111`	RESERVED
`E0..EF`	`1110xxxx`	RESERVED
`F0..FF`	`1111xxxx`	-TINY_INT	Integer -1 to -16

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PackStream.EndOfStream`
`static class`	`PackStream.Overflow`
`static class`	`PackStream.Packer`
`static class`	`PackStream.PackStreamException`
`static class`	`PackStream.Unexpected`
`static class`	`PackStream.Unpacker`

Field Summary

Fields
Modifier and Type	Field and Description
`static byte`	`BYTES_16`
`static byte`	`BYTES_32`
`static byte`	`BYTES_8`
`static byte`	`END_OF_STREAM`
`static byte`	`FALSE`
`static byte`	`FLOAT_64`
`static byte`	`INT_16`
`static byte`	`INT_32`
`static byte`	`INT_64`
`static byte`	`INT_8`
`static byte`	`LIST_16`
`static byte`	`LIST_32`
`static byte`	`LIST_8`
`static byte`	`LIST_STREAM`
`static byte`	`MAP_16`
`static byte`	`MAP_32`
`static byte`	`MAP_8`
`static byte`	`MAP_STREAM`
`static byte`	`NULL`
`static byte`	`RESERVED_C4`
`static byte`	`RESERVED_C5`
`static byte`	`RESERVED_C6`
`static byte`	`RESERVED_C7`
`static byte`	`RESERVED_CF`
`static byte`	`RESERVED_D3`
`static byte`	`RESERVED_DE`
`static byte`	`RESERVED_E0`
`static byte`	`RESERVED_E1`
`static byte`	`RESERVED_E2`
`static byte`	`RESERVED_E3`
`static byte`	`RESERVED_E4`
`static byte`	`RESERVED_E5`
`static byte`	`RESERVED_E6`
`static byte`	`RESERVED_E7`
`static byte`	`RESERVED_E8`
`static byte`	`RESERVED_E9`
`static byte`	`RESERVED_EA`
`static byte`	`RESERVED_EB`
`static byte`	`RESERVED_EC`
`static byte`	`RESERVED_ED`
`static byte`	`RESERVED_EE`
`static byte`	`RESERVED_EF`
`static byte`	`STRING_16`
`static byte`	`STRING_32`
`static byte`	`STRING_8`
`static byte`	`STRUCT_16`
`static byte`	`STRUCT_8`
`static byte`	`TINY_LIST`
`static byte`	`TINY_MAP`
`static byte`	`TINY_STRING`
`static byte`	`TINY_STRUCT`
`static byte`	`TRUE`
`static long`	`UNKNOWN_SIZE`

Method Summary
- Methods inherited from class java.lang.Object
  equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TINY_STRING
```
public static final byte TINY_STRING
```
    See Also:
    
    Constant Field Values
  - TINY_LIST
```
public static final byte TINY_LIST
```
    See Also:
    
    Constant Field Values
  - TINY_MAP
```
public static final byte TINY_MAP
```
    See Also:
    
    Constant Field Values
  - TINY_STRUCT
```
public static final byte TINY_STRUCT
```
    See Also:
    
    Constant Field Values
  - NULL
```
public static final byte NULL
```
    See Also:
    
    Constant Field Values
  - FLOAT_64
```
public static final byte FLOAT_64
```
    See Also:
    
    Constant Field Values
  - FALSE
```
public static final byte FALSE
```
    See Also:
    
    Constant Field Values
  - TRUE
```
public static final byte TRUE
```
    See Also:
    
    Constant Field Values
  - RESERVED_C4
```
public static final byte RESERVED_C4
```
    See Also:
    
    Constant Field Values
  - RESERVED_C5
```
public static final byte RESERVED_C5
```
    See Also:
    
    Constant Field Values
  - RESERVED_C6
```
public static final byte RESERVED_C6
```
    See Also:
    
    Constant Field Values
  - RESERVED_C7
```
public static final byte RESERVED_C7
```
    See Also:
    
    Constant Field Values
  - INT_8
```
public static final byte INT_8
```
    See Also:
    
    Constant Field Values
  - INT_16
```
public static final byte INT_16
```
    See Also:
    
    Constant Field Values
  - INT_32
```
public static final byte INT_32
```
    See Also:
    
    Constant Field Values
  - INT_64
```
public static final byte INT_64
```
    See Also:
    
    Constant Field Values
  - BYTES_8
```
public static final byte BYTES_8
```
    See Also:
    
    Constant Field Values
  - BYTES_16
```
public static final byte BYTES_16
```
    See Also:
    
    Constant Field Values
  - BYTES_32
```
public static final byte BYTES_32
```
    See Also:
    
    Constant Field Values
  - RESERVED_CF
```
public static final byte RESERVED_CF
```
    See Also:
    
    Constant Field Values
  - STRING_8
```
public static final byte STRING_8
```
    See Also:
    
    Constant Field Values
  - STRING_16
```
public static final byte STRING_16
```
    See Also:
    
    Constant Field Values
  - STRING_32
```
public static final byte STRING_32
```
    See Also:
    
    Constant Field Values
  - RESERVED_D3
```
public static final byte RESERVED_D3
```
    See Also:
    
    Constant Field Values
  - LIST_8
```
public static final byte LIST_8
```
    See Also:
    
    Constant Field Values
  - LIST_16
```
public static final byte LIST_16
```
    See Also:
    
    Constant Field Values
  - LIST_32
```
public static final byte LIST_32
```
    See Also:
    
    Constant Field Values
  - LIST_STREAM
```
public static final byte LIST_STREAM
```
    See Also:
    
    Constant Field Values
  - MAP_8
```
public static final byte MAP_8
```
    See Also:
    
    Constant Field Values
  - MAP_16
```
public static final byte MAP_16
```
    See Also:
    
    Constant Field Values
  - MAP_32
```
public static final byte MAP_32
```
    See Also:
    
    Constant Field Values
  - MAP_STREAM
```
public static final byte MAP_STREAM
```
    See Also:
    
    Constant Field Values
  - STRUCT_8
```
public static final byte STRUCT_8
```
    See Also:
    
    Constant Field Values
  - STRUCT_16
```
public static final byte STRUCT_16
```
    See Also:
    
    Constant Field Values
  - RESERVED_DE
```
public static final byte RESERVED_DE
```
    See Also:
    
    Constant Field Values
  - END_OF_STREAM
```
public static final byte END_OF_STREAM
```
    See Also:
    
    Constant Field Values
  - RESERVED_E0
```
public static final byte RESERVED_E0
```
    See Also:
    
    Constant Field Values
  - RESERVED_E1
```
public static final byte RESERVED_E1
```
    See Also:
    
    Constant Field Values
  - RESERVED_E2
```
public static final byte RESERVED_E2
```
    See Also:
    
    Constant Field Values
  - RESERVED_E3
```
public static final byte RESERVED_E3
```
    See Also:
    
    Constant Field Values
  - RESERVED_E4
```
public static final byte RESERVED_E4
```
    See Also:
    
    Constant Field Values
  - RESERVED_E5
```
public static final byte RESERVED_E5
```
    See Also:
    
    Constant Field Values
  - RESERVED_E6
```
public static final byte RESERVED_E6
```
    See Also:
    
    Constant Field Values
  - RESERVED_E7
```
public static final byte RESERVED_E7
```
    See Also:
    
    Constant Field Values
  - RESERVED_E8
```
public static final byte RESERVED_E8
```
    See Also:
    
    Constant Field Values
  - RESERVED_E9
```
public static final byte RESERVED_E9
```
    See Also:
    
    Constant Field Values
  - RESERVED_EA
```
public static final byte RESERVED_EA
```
    See Also:
    
    Constant Field Values
  - RESERVED_EB
```
public static final byte RESERVED_EB
```
    See Also:
    
    Constant Field Values
  - RESERVED_EC
```
public static final byte RESERVED_EC
```
    See Also:
    
    Constant Field Values
  - RESERVED_ED
```
public static final byte RESERVED_ED
```
    See Also:
    
    Constant Field Values
  - RESERVED_EE
```
public static final byte RESERVED_EE
```
    See Also:
    
    Constant Field Values
  - RESERVED_EF
```
public static final byte RESERVED_EF
```
    See Also:
    
    Constant Field Values
  - UNKNOWN_SIZE
```
public static final long UNKNOWN_SIZE
```
    See Also:
    
    Constant Field Values

Class PackStream

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TINY_STRING

TINY_LIST

TINY_MAP

TINY_STRUCT

NULL

FLOAT_64

FALSE

TRUE

RESERVED_C4

RESERVED_C5

RESERVED_C6

RESERVED_C7

INT_8

INT_16

INT_32

INT_64

BYTES_8

BYTES_16

BYTES_32

RESERVED_CF

STRING_8

STRING_16

STRING_32

RESERVED_D3

LIST_8

LIST_16

LIST_32

LIST_STREAM

MAP_8

MAP_16

MAP_32

MAP_STREAM

STRUCT_8

STRUCT_16

RESERVED_DE

END_OF_STREAM

RESERVED_E0

RESERVED_E1

RESERVED_E2

RESERVED_E3

RESERVED_E4

RESERVED_E5

RESERVED_E6

RESERVED_E7

RESERVED_E8

RESERVED_E9

RESERVED_EA

RESERVED_EB

RESERVED_EC

RESERVED_ED

RESERVED_EE

RESERVED_EF

UNKNOWN_SIZE