Class: Thrift::BinaryProtocol

Inherits:
BaseProtocol show all
Defined in:
lib/thrift/protocol/binary_protocol.rb

Constant Summary collapse

VERSION_MASK = 
0xffff0000
VERSION_1 = 
0x80010000
TYPE_MASK = 
0x000000ff

Instance Attribute Summary collapse

Attributes inherited from BaseProtocol

#trans

Instance Method Summary collapse

Methods inherited from BaseProtocol

#native?, #read_field_end, #read_list_end, #read_map_end, #read_message_end, #read_set_end, #read_struct_end, #read_type, #skip, #write_field, #write_field_end, #write_list_end, #write_map_end, #write_message_end, #write_set_end, #write_struct_end, #write_type

Constructor Details

#initialize(trans, strict_read = true, strict_write = true) ⇒ BinaryProtocol

Returns a new instance of BinaryProtocol.



28
29
30
31
32
33
34
35
36
37
 
# File 'lib/thrift/protocol/binary_protocol.rb', line 28

def initialize(trans, strict_read=true, strict_write=true)
  super(trans)
  @strict_read = strict_read
  @strict_write = strict_write

  # Pre-allocated read buffer for fixed-size read methods. Needs to be at least 8 bytes long for
  # read_i64() and read_double().
  @rbuf = "\0" * 8
  @rbuf.force_encoding("BINARY") if @rbuf.respond_to?(:force_encoding)
end

Instance Attribute Details

#strict_read ⇒ Object (readonly)

Returns the value of attribute strict_read.



26
27
28
 
# File 'lib/thrift/protocol/binary_protocol.rb', line 26

def strict_read
  @strict_read
end

#strict_write ⇒ Object (readonly)

Returns the value of attribute strict_write.



26
27
28
 
# File 'lib/thrift/protocol/binary_protocol.rb', line 26

def strict_write
  @strict_write
end

Instance Method Details

#read_bool ⇒ Object 



167
168
169
170
 
# File 'lib/thrift/protocol/binary_protocol.rb', line 167

def read_bool
  byte = read_byte
  byte != 0
end

#read_byte ⇒ Object 



172
173
174
175
176
177
178
 
# File 'lib/thrift/protocol/binary_protocol.rb', line 172

def read_byte
  val = trans.read_byte
  if (val > 0x7f)
    val = 0 - ((val - 1) ^ 0xff)
  end
  val
end

#read_double ⇒ Object 



210
211
212
213
214
 
# File 'lib/thrift/protocol/binary_protocol.rb', line 210

def read_double
  trans.read_into_buffer(@rbuf, 8)
  val = @rbuf.unpack('G').first
  val
end

#read_field_begin ⇒ Object 



138
139
140
141
142
143
144
145
146
 
# File 'lib/thrift/protocol/binary_protocol.rb', line 138

def read_field_begin
  type = read_byte
  if (type == Types::STOP)
    [nil, type, 0]
  else
    id = read_i16
    [nil, type, id]
  end
end

#read_i16 ⇒ Object 



180
181
182
183
184
185
186
187
 
# File 'lib/thrift/protocol/binary_protocol.rb', line 180

def read_i16
  trans.read_into_buffer(@rbuf, 2)
  val, = @rbuf.unpack('n')
  if (val > 0x7fff)
    val = 0 - ((val - 1) ^ 0xffff)
  end
  val
end

#read_i32 ⇒ Object 



189
190
191
192
193
194
195
196
 
# File 'lib/thrift/protocol/binary_protocol.rb', line 189

def read_i32
  trans.read_into_buffer(@rbuf, 4)
  val, = @rbuf.unpack('N')
  if (val > 0x7fffffff)
    val = 0 - ((val - 1) ^ 0xffffffff)
  end
  val
end

#read_i64 ⇒ Object 



198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/thrift/protocol/binary_protocol.rb', line 198

def read_i64
  trans.read_into_buffer(@rbuf, 8)
  hi, lo = @rbuf.unpack('N2')
  if (hi > 0x7fffffff)
    hi ^= 0xffffffff
    lo ^= 0xffffffff
    0 - (hi << 32) - lo - 1
  else
    (hi << 32) + lo
  end
end

#read_list_begin ⇒ Object 



155
156
157
158
159
 
# File 'lib/thrift/protocol/binary_protocol.rb', line 155

def read_list_begin
  etype = read_byte
  size = read_i32
  [etype, size]
end

#read_map_begin ⇒ Object 



148
149
150
151
152
153
 
# File 'lib/thrift/protocol/binary_protocol.rb', line 148

def read_map_begin
  ktype = read_byte
  vtype = read_byte
  size = read_i32
  [ktype, vtype, size]
end

#read_message_begin ⇒ Object 



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/thrift/protocol/binary_protocol.rb', line 115

def read_message_begin
  version = read_i32
  if version < 0
    if (version & VERSION_MASK != VERSION_1)
      raise ProtocolException.new(ProtocolException::BAD_VERSION, 'Missing version identifier')
    end
    type = version & TYPE_MASK
    name = read_string
    seqid = read_i32
    [name, type, seqid]
  else
    if strict_read
      raise ProtocolException.new(ProtocolException::BAD_VERSION, 'No version identifier, old protocol client?')
    end
    name = trans.read_all(version)
    type = read_byte
    seqid = read_i32
    [name, type, seqid]
  end
end

#read_set_begin ⇒ Object 



161
162
163
164
165
 
# File 'lib/thrift/protocol/binary_protocol.rb', line 161

def read_set_begin
  etype = read_byte
  size = read_i32
  [etype, size]
end

#read_string ⇒ Object 



216
217
218
219
220
 
# File 'lib/thrift/protocol/binary_protocol.rb', line 216

def read_string
  sz = read_i32
  dat = trans.read_all(sz)
  dat
end

#read_struct_begin ⇒ Object 



136
 
# File 'lib/thrift/protocol/binary_protocol.rb', line 136

def read_struct_begin; nil; end

#write_bool(bool) ⇒ Object 



81
82
83
 
# File 'lib/thrift/protocol/binary_protocol.rb', line 81

def write_bool(bool)
  write_byte(bool ? 1 : 0)
end

#write_byte(byte) ⇒ Object

Raises:

  • (RangeError) 


85
86
87
88
 
# File 'lib/thrift/protocol/binary_protocol.rb', line 85

def write_byte(byte)
  raise RangeError if byte < -2**31 || byte >= 2**32
  trans.write([byte].pack('c'))
end

#write_double(dub) ⇒ Object 



106
107
108
 
# File 'lib/thrift/protocol/binary_protocol.rb', line 106

def write_double(dub)
  trans.write([dub].pack('G'))
end

#write_field_begin(name, type, id) ⇒ Object 



56
57
58
59
 
# File 'lib/thrift/protocol/binary_protocol.rb', line 56

def write_field_begin(name, type, id)
  write_byte(type)
  write_i16(id)
end

#write_field_stop ⇒ Object 



61
62
63
 
# File 'lib/thrift/protocol/binary_protocol.rb', line 61

def write_field_stop
  write_byte(Thrift::Types::STOP)
end

#write_i16(i16) ⇒ Object 



90
91
92
 
# File 'lib/thrift/protocol/binary_protocol.rb', line 90

def write_i16(i16)
  trans.write([i16].pack('n'))
end

#write_i32(i32) ⇒ Object

Raises:

  • (RangeError) 


94
95
96
97
 
# File 'lib/thrift/protocol/binary_protocol.rb', line 94

def write_i32(i32)
  raise RangeError if i32 < -2**31 || i32 >= 2**31
  trans.write([i32].pack('N'))
end

#write_i64(i64) ⇒ Object

Raises:

  • (RangeError) 


99
100
101
102
103
104
 
# File 'lib/thrift/protocol/binary_protocol.rb', line 99

def write_i64(i64)
  raise RangeError if i64 < -2**63 || i64 >= 2**64
  hi = i64 >> 32
  lo = i64 & 0xffffffff
  trans.write([hi, lo].pack('N2'))
end

#write_list_begin(etype, size) ⇒ Object 



71
72
73
74
 
# File 'lib/thrift/protocol/binary_protocol.rb', line 71

def write_list_begin(etype, size)
  write_byte(etype)
  write_i32(size)
end

#write_map_begin(ktype, vtype, size) ⇒ Object 



65
66
67
68
69
 
# File 'lib/thrift/protocol/binary_protocol.rb', line 65

def write_map_begin(ktype, vtype, size)
  write_byte(ktype)
  write_byte(vtype)
  write_i32(size)
end

#write_message_begin(name, type, seqid) ⇒ Object 



39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/thrift/protocol/binary_protocol.rb', line 39

def write_message_begin(name, type, seqid)
  # this is necessary because we added (needed) bounds checking to 
  # write_i32, and 0x80010000 is too big for that.
  if strict_write
    write_i16(VERSION_1 >> 16)
    write_i16(type)
    write_string(name)
    write_i32(seqid)
  else
    write_string(name)
    write_byte(type)
    write_i32(seqid)
  end
end

#write_set_begin(etype, size) ⇒ Object 



76
77
78
79
 
# File 'lib/thrift/protocol/binary_protocol.rb', line 76

def write_set_begin(etype, size)
  write_byte(etype)
  write_i32(size)
end

#write_string(str) ⇒ Object 



110
111
112
113
 
# File 'lib/thrift/protocol/binary_protocol.rb', line 110

def write_string(str)
  write_i32(str.length)
  trans.write(str)
end

#write_struct_begin(name) ⇒ Object 



54
 
# File 'lib/thrift/protocol/binary_protocol.rb', line 54

def write_struct_begin(name); nil; end