▼Package thrift.
►4 Thrift Protocol Support
On this page:
4.1 Protocol Common
protocol-id
message-header
field-header
map-header
list-or-set
encoder
decoder
4.2 Binary Protocol
make-binary-encoder
make-binary-decoder
4.3 Compact Protocol
make-compact-encoder
make-compact-decoder
4.4 JSON Protocol
make-json-encoder
make-json-decoder
4.5 Multiplexed Protocol
mux-message-header
make-multiplexed-encoder
make-multiplexed-decoder
register-service
deregister-service
4.6 S-Expression Protocol
make-sexpression-encoder
make-sexpression-decoder
4.7 Encoding Support
encode-exn
4.8 Decoding Support
type-bool/  decode
type-byte/  decode
type-int16/  decode
type-int32/  decode
type-int64/  decode
type-double/  decode
type-string/  decode
type-binary/  decode
type-bool/  decode-list
type-byte/  decode-list
type-int16/  decode-list
type-int32/  decode-list
type-int64/  decode-list
type-double/  decode-list
type-string/  decode-list
type-binary/  decode-list
decode-a-list
decode-a-union
decode-a-struct
8.12
  top  contents    up   

4 Thrift Protocol Support🔗ℹ

Support for Thrift protocol encodings

4.1 Protocol Common🔗ℹ

 (require thrift/protocol/common) package: thrift

struct

(struct protocol-id (string numeric version))

  string : string?
  numeric : number?
  version : number?
TBD

struct

(struct message-header (name type sequence-id))

  name : string?
  type : type?
  sequence-id : integer?
TBD

struct

(struct field-header (name type id))

  name : string?
  type : type?
  id : exact-nonnegative-integer?
TBD

struct

(struct map-header (key-type element-type length))

  key-type : type?
  element-type : type?
  length : exact-nonnegative-integer?
TBD

struct

(struct list-or-set (element-type length))

  element-type : type?
  length : exact-nonnegative-integer?
TBD

struct

(struct encoder (name
    message-begin
    message-end
    struct-begin
    struct-end
    field-begin
    field-end
    field-stop
    map-begin
    map-end
    list-begin
    list-end
    set-begin
    set-end
    boolean
    byte
    bytes
    int16
    int32
    int64
    double
    string))
  name : string?
  message-begin : (-> message-header? any/c)
  message-end : (-> any/c)
  struct-begin : (-> string? any/c)
  struct-end : (-> any/c)
  field-begin : (-> field-header any/c)
  field-end : (-> any/c)
  field-stop : (-> any/c)
  map-begin : (-> map-header? any/c)
  map-end : (-> any/c)
  list-begin : (-> list-or-set? any/c)
  list-end : (-> any/c)
  set-begin : (-> list-or-set? any/c)
  set-end : (-> any/c)
  boolean : (-> boolean? any/c)
  byte : (-> byte? any/c)
  bytes : (-> bytes? any/c)
  int16 : (-> integer? any/c)
  int32 : (-> integer? any/c)
  int64 : (-> integer? any/c)
  double : (-> flonum? any/c)
  string : (-> string? any/c)
TBD

struct

(struct decoder (name
    message-begin
    message-end
    struct-begin
    struct-end
    field-begin
    field-end
    field-stop
    map-begin
    map-end
    list-begin
    list-end
    set-begin
    set-end
    boolean
    byte
    bytes
    int16
    int32
    int64
    double
    string))
  name : string?
  message-begin : (-> message-header?)
  message-end : (-> void?)
  struct-begin : (-> string?)
  struct-end : (-> void?)
  field-begin : (-> field-header?)
  field-end : (-> void?)
  field-stop : (-> any/c)
  map-begin : (-> map-header?)
  map-end : (-> void?)
  list-begin : (-> list-or-set?)
  list-end : (-> void?)
  set-begin : (-> list-or-set?)
  set-end : (-> void?)
  boolean : (-> boolean?)
  byte : (-> byte?)
  bytes : (-> bytes?)
  int16 : (-> integer?)
  int32 : (-> integer?)
  int64 : (-> integer?)
  double : (-> flonum?)
  string : (-> string?)
TBD

4.2 Binary Protocol🔗ℹ

 (require thrift/protocol/binary) package: thrift

This protocol is described by the Binary Protocol specification.

procedure

(make-binary-encoder t) → (or/c encoder? #f)

  t : transport?
TBD

procedure

(make-binary-decoder t) → (or/c decoder? #f)

  t : transport?
TBD

4.3 Compact Protocol🔗ℹ

 (require thrift/protocol/compact) package: thrift

This protocol is described by the Compact Protocol specification.

procedure

(make-compact-encoder t) → (or/c encoder? #f)

  t : transport?
TBD

procedure

(make-compact-decoder t) → (or/c decoder? #f)

  t : transport?
TBD

4.4 JSON Protocol🔗ℹ

 (require thrift/protocol/json) package: thrift

procedure

(make-json-encoder t) → (or/c encoder? #f)

  t : transport?
TBD

procedure

(make-json-decoder t) → (or/c decoder? #f)

  t : transport?
TBD

4.5 Multiplexed Protocol🔗ℹ

 (require thrift/protocol/multiplexed) package: thrift

This protocol wraps an existing protocol with the ability to support the calling of multiple services over the same protocol/transport pair. It is described by the THRIFT-563 issue.

struct

(struct mux-message-header message-header (service-name))

  service-name : string?
TBD

procedure

(make-multiplexed-encoder wrapped) → (or/c encoder? #f)

  wrapped : encoder?
TBD

procedure

(make-multiplexed-decoder wrapped) → (or/c decoder? #f)

  wrapped : decoder?
TBD

procedure

(register-service mux    
  service-name    
  processor) → void?
  mux : decoder?
  service-name : string?
  processor : protocol-processor/c
TBD

procedure

(deregister-service mux service-name) → void?

  mux : decoder?
  service-name : string?
TBD

4.6 S-Expression Protocol🔗ℹ

 (require thrift/protocol/sexpression) package: thrift

This protocol is intended as a more Racket friendly debug protocol.

procedure

(make-sexpression-encoder t) → (or/c encoder? #f)

  t : transport?
TBD

procedure

(make-sexpression-decoder t) → (or/c decoder? #f)

  t : transport?
TBD

4.7 Encoding Support🔗ℹ

 (require thrift/protocol/encoding) package: thrift

procedure

(encode-exn e exn reply-to) → void?

  e : encoder?
  exn : exn:thrift?
  reply-to : (or/c message-header? #f)
TBD

4.8 Decoding Support🔗ℹ

 (require thrift/protocol/decoding) package: thrift

procedure

(type-bool/decode d) → boolean?

  d : decoder?

procedure

(type-byte/decode d) → byte?

  d : decoder?

procedure

(type-int16/decode d) → integer?

  d : decoder?

procedure

(type-int32/decode d) → integer?

  d : decoder?

procedure

(type-int64/decode d) → integer?

  d : decoder?

procedure

(type-double/decode d) → flonum?

  d : decoder?

procedure

(type-string/decode d) → string?

  d : decoder?

procedure

(type-binary/decode d) → bytes?

  d : decoder?
TBD

procedure

(type-bool/decode-list d) → (listof boolean?)

  d : decoder?

procedure

(type-byte/decode-list d) → (listof byte?)

  d : decoder?

procedure

(type-int16/decode-list d) → (listof integer?)

  d : decoder?

procedure

(type-int32/decode-list d) → (listof integer?)

  d : decoder?

procedure

(type-int64/decode-list d) → (listof integer?)

  d : decoder?

procedure

(type-double/decode-list d) → (listof flonum?)

  d : decoder?

procedure

(type-string/decode-list d) → (listof string?)

  d : decoder?

procedure

(type-binary/decode-list d) → (listof bytes?)

  d : decoder?
TBD

procedure

(decode-a-list d element-decoder) → list?

  d : decoder?
  element-decoder : procedure?
TBD

procedure

(decode-a-union d constructor struct-schema) → struct?

  d : decoder?
  constructor : procedure?
  struct-schema : (hash/c exact-nonnegative-integer? thrift-field?)
TBD

procedure

(decode-a-struct d struct-schema) → struct?

  d : decoder?
  struct-schema : (hash/c exact-nonnegative-integer? thrift-field?)
TBD

  top  contents    up