Tungsten Replicator 2.2 Manual

Replication Filters
}
8.4.15.2. Network Filter Protocol
The network filter protocol has been designed to be both lightweight and binary data compatible, as it is designed to work with data that
may be heavily encoded, binary, or compressed in nature.
The protocol operates through a combined JSON and optional binary payload structure that communicates the information. The JSON
defines the communication type and metadata, while the binary payload contains the raw or translated information.
The filter communicates with the network server using the following packet types:
• prepare
The prepare message is called when the filter goes online, and is designed to initalize the connection to the network server and confirm
the supported filter types and operation. The format of the connection message is:
{
}
"payload" : -1,
"type" : "prepare",
"service" : "firstrep",
"protocol" : "v0_9"
Where:
• protocol
The protocol version.
• service
The name of the replicator service that called the filter.
• type [316]
The message type.
• payload
The size of the payload; a value of -1 indicates that there is no payload.
The format of the response should be a JSON object and payload with the list of supported filter types in the payload section. The
payload immediately follows the JSON, with the size of the list defined within the payload field of the returned JSON object:
{
"payload" : 22,
"type" : "acknowledged",
"protocol" : "v0_9",
"service" : "firstrep",
"return" : 0
}Perl_BLOB_to_String_v1
Where:
• protocol
The protocol version.
• service
The name of the replicator service that called the filter.
• type [316]
The message type; when acknowledging the original prepare request it should be acknowledge.
• return
The return value. A value of 0 (zero) indicates no faults. Any true value indicates there was an issue.
• payload
The length of the appended payload information in bytes. This is used by the filter to identify how much additional data to read after
the JSON object has been read.
255