Protocol Overview

Protocols

Protocols include:

• :binary: The Thrift binary protocol. Options:
  • :strict-read: require a version number at the beginning of each incoming message
  • :strict-write: place a version number at the beginning of each outgoing message
  • :read-length: maximum number of bytes per message
• :compact: The Thrift compact protocol. Options:
  • :max-network-bytes: the maximum number of bytes to read for variable-length fields
• :tuple: The Thrift tuple protocol (an extension of :compact). No options.
• :json: The Thrift JSON protocol. No options.
• :simple-json: The Thrift simple JSON protocol. This is write-only!

For servers and clients you can usually either use the protocol ID by itself or a vector of the ID followed by pairs of options, e.g. [:binary :strict-read true :strict-write true].

Protocol Factories

You can create an instance of org.apache.thrift.protocol.TProtocolFactory using the function thrift-clj.protocol.core/protocol-factory with a protocol ID and some additional options.

Example:

(require '[thrift-clj.protocol.core :as proto])
(def f (proto/protocol-factory :binary
          :strict-read true
          :strict-write true))
(def p (.getProtocol f some-transport))

If you want to directly create a protocol (which you probably won't need to), use thrift-clj.protocol.core/protocol:

(def p (proto/protocol :binary some-transport
         :strict-read true
         :strict-write true))

You can add your own protocol factories by implementing the multimethod thrift-clj.protocol.core/protocol-factory*.