net.sergeych.boss

Class Boss

java.lang.Object

net.sergeych.boss.Boss

public class Boss
extends java.lang.Object

BOSS (Binary Object Serialization Specification) protocol version 1.4 final stream mode specification (no-cache).

Specification version: 1.4 (stream mode with no caching, regular cached mode)

BOSS is an acronym for Binary Object Streaming Specification.

The bit-effective, platform-independent streamable and traversable typed binary protocol. Allow to effectively store small or any sized integers, strings or binary data of any size, floats and doubles, arrays and hashes and time objects in a very effective way. It caches repeating objects and stores/restores links to objects.

The protocol allow to effectively store texts and binary data of absolutely any size, signed integers of absolutely any size, arrays and hashes with no limit on items and overall gross size. It is desirable to use build-in compression when appropriate.

Streamable means that you can use a pipe (for example tcp/ip), put the object at one side and load it on other, one-by-one, and caching and links will be restored properly.

Initially, this protocol was intended to be used in secure communications. Its gui.main.main goal was to very effective data sending and is a great replacement for json/boss/whatever. For example, typical JSON reduces in size twice with Boss.

Boss protocol also allow to transparently compress its representations.

Boss also supports "stream mode" that lacks tree reconstruction but could be effectively use when implementing long-living streams (e.g. stream protocols). In regular mode it causes unlimited cache grows as Boss would try to reconstruct all possible references to already serialized objects. In the stream mode only strings are cached, and cache size and capacity are dynamically limited. Boss writes stream mode marker and handles stream mode on receiving end automatically.

Supported types:

  - Signed integers of any length
  - Signed floats and doubles (4 or 8 bytes)
  - Boolean values (true/false)
  - UTF-8 encoded texts, any length
  - Binary data, any length
  - Date objects (date and time with 1 second resolution)
  - Arrays with any number of mixed type elements
  - Hashes with any keys and values and unlimited length
  - Reference to the object that already was serialized (unless in stream mode)
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Boss.Dictionary
protected static class	Boss.Header
static class	Boss.Reader
static class	Boss.Writer BOSS serializer.

Constructor Summary

Constructors

Constructor and Description
Boss()

Method Summary

Modifier and Type	Method and Description
static Bytes	dump(java.lang.Object first, java.lang.Object... objects) Encodes one or more objects one by one.
static byte[]	dumpToArray(java.lang.Object first, java.lang.Object... objects) Encodes one or more objects one by one.
static boolean	isUseOldDates()
static <T> T	load(byte[] data) Load boss-encoded object tree from binary data.
static <T> T	load(byte[] data, BiDeserializer mapper)
static <T> T	load(Bytes bytes) Load boss-encoded object tree from binary data.
static <K,V> java.util.Map<K,V>	loadMap(Bytes bytes)
static byte[]	pack(java.lang.Object object)
static void	setUseOldDates(boolean useOldDates) Set to true to use Date class instead of ZonedDateTime (default)
static void	trace(byte[] packed)
static void	trace(java.lang.Object object)
static Binder	unpack(byte[] data) Load boss-encoded object and cast ti to Binder.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Boss

public Boss()

Method Detail

isUseOldDates

public static boolean isUseOldDates()

Returns:

true if Boss decodes date to Date class instead of ZonedDateTime (default behavior)

setUseOldDates

public static void setUseOldDates(boolean useOldDates)

Set to true to use Date class instead of ZonedDateTime (default)

dump

public static Bytes dump(java.lang.Object first,
                         java.lang.Object... objects)

Encodes one or more objects one by one. It will need corresponding number of read calls

Parameters:

objects - objects one by one

Returns:

binary data

pack

public static byte[] pack(java.lang.Object object)

dumpToArray

public static byte[] dumpToArray(java.lang.Object first,
                                 java.lang.Object... objects)

Encodes one or more objects one by one. It will need corresponding number of read calls

Parameters:

objects - objects one by one

Returns:

binary data as plain array

loadMap

public static <K,V> java.util.Map<K,V> loadMap(Bytes bytes)

load

public static <T> T load(Bytes bytes)

Load boss-encoded object tree from binary data. See BiAdapter on how to serialize any types.

Parameters:

bytes - data to load

Returns:

root object

load

public static <T> T load(byte[] data)

Load boss-encoded object tree from binary data. See BiAdapter on how to serialize any types.

Parameters:

data - binary data to decode

Returns:

root object

load

public static <T> T load(byte[] data,
                         BiDeserializer mapper)

unpack

public static Binder unpack(byte[] data)

Load boss-encoded object and cast ti to Binder.

Parameters:

data -

Returns:

trace

public static void trace(byte[] packed)

trace

public static void trace(java.lang.Object object)