Class: Thrift::BaseProtocol

Inherits:
Object
  • Object
show all
Defined in:
lib/thrift/protocol/base_protocol.rb

Direct Known Subclasses

BinaryProtocol, CompactProtocol, JsonProtocol

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(trans) ⇒ BaseProtocol

Returns a new instance of BaseProtocol.



44
45
46
 
# File 'lib/thrift/protocol/base_protocol.rb', line 44

def initialize(trans)
  @trans = trans
end

Instance Attribute Details

#trans ⇒ Object (readonly)

Returns the value of attribute trans.



42
43
44
 
# File 'lib/thrift/protocol/base_protocol.rb', line 42

def trans
  @trans
end

Instance Method Details

#native? ⇒ Boolean

Returns:

  • (Boolean) 


48
49
50
51
 
# File 'lib/thrift/protocol/base_protocol.rb', line 48

def native?
  puts "wrong method is being called!"
  false
end

#read_bool ⇒ Object

Raises:

  • (NotImplementedError) 


164
165
166
 
# File 'lib/thrift/protocol/base_protocol.rb', line 164

def read_bool
  raise NotImplementedError
end

#read_byte ⇒ Object

Raises:

  • (NotImplementedError) 


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

def read_byte
  raise NotImplementedError
end

#read_double ⇒ Object

Raises:

  • (NotImplementedError) 


184
185
186
 
# File 'lib/thrift/protocol/base_protocol.rb', line 184

def read_double
  raise NotImplementedError
end

#read_field_begin ⇒ Object

Raises:

  • (NotImplementedError) 


140
141
142
 
# File 'lib/thrift/protocol/base_protocol.rb', line 140

def read_field_begin
  raise NotImplementedError
end

#read_field_end ⇒ Object 



144
 
# File 'lib/thrift/protocol/base_protocol.rb', line 144

def read_field_end; nil; end

#read_i16 ⇒ Object

Raises:

  • (NotImplementedError) 


172
173
174
 
# File 'lib/thrift/protocol/base_protocol.rb', line 172

def read_i16
  raise NotImplementedError
end

#read_i32 ⇒ Object

Raises:

  • (NotImplementedError) 


176
177
178
 
# File 'lib/thrift/protocol/base_protocol.rb', line 176

def read_i32
  raise NotImplementedError
end

#read_i64 ⇒ Object

Raises:

  • (NotImplementedError) 


180
181
182
 
# File 'lib/thrift/protocol/base_protocol.rb', line 180

def read_i64
  raise NotImplementedError
end

#read_list_begin ⇒ Object

Raises:

  • (NotImplementedError) 


152
153
154
 
# File 'lib/thrift/protocol/base_protocol.rb', line 152

def read_list_begin
  raise NotImplementedError
end

#read_list_end ⇒ Object 



156
 
# File 'lib/thrift/protocol/base_protocol.rb', line 156

def read_list_end; nil; end

#read_map_begin ⇒ Object

Raises:

  • (NotImplementedError) 


146
147
148
 
# File 'lib/thrift/protocol/base_protocol.rb', line 146

def read_map_begin
  raise NotImplementedError
end

#read_map_end ⇒ Object 



150
 
# File 'lib/thrift/protocol/base_protocol.rb', line 150

def read_map_end; nil; end

#read_message_begin ⇒ Object

Raises:

  • (NotImplementedError) 


128
129
130
 
# File 'lib/thrift/protocol/base_protocol.rb', line 128

def read_message_begin
  raise NotImplementedError
end

#read_message_end ⇒ Object 



132
 
# File 'lib/thrift/protocol/base_protocol.rb', line 132

def read_message_end; nil; end

#read_set_begin ⇒ Object

Raises:

  • (NotImplementedError) 


158
159
160
 
# File 'lib/thrift/protocol/base_protocol.rb', line 158

def read_set_begin
  raise NotImplementedError
end

#read_set_end ⇒ Object 



162
 
# File 'lib/thrift/protocol/base_protocol.rb', line 162

def read_set_end; nil; end

#read_string ⇒ Object

Reads a Thrift String. In Ruby 1.9+, all String will be returned with an Encoding of UTF-8.

Returns a String.

Raises:

  • (NotImplementedError) 


191
192
193
 
# File 'lib/thrift/protocol/base_protocol.rb', line 191

def read_string
  raise NotImplementedError
end

#read_struct_begin ⇒ Object

Raises:

  • (NotImplementedError) 


134
135
136
 
# File 'lib/thrift/protocol/base_protocol.rb', line 134

def read_struct_begin
  raise NotImplementedError
end

#read_struct_end ⇒ Object 



138
 
# File 'lib/thrift/protocol/base_protocol.rb', line 138

def read_struct_end; nil; end

#read_type(type) ⇒ Object 



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/thrift/protocol/base_protocol.rb', line 224

def read_type(type)
  case type
  when Types::BOOL
    read_bool
  when Types::BYTE
    read_byte
  when Types::DOUBLE
    read_double
  when Types::I16
    read_i16
  when Types::I32
    read_i32
  when Types::I64
    read_i64
  when Types::STRING
    read_string
  else
    raise NotImplementedError
  end
end

#skip(type) ⇒ Object 



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/thrift/protocol/base_protocol.rb', line 245

def skip(type)
  case type
  when Types::STOP
    nil
  when Types::BOOL
    read_bool
  when Types::BYTE
    read_byte
  when Types::I16
    read_i16
  when Types::I32
    read_i32
  when Types::I64
    read_i64
  when Types::DOUBLE
    read_double
  when Types::STRING
    read_string
  when Types::STRUCT
    read_struct_begin
    while true
      name, type, id = read_field_begin
      break if type == Types::STOP
      skip(type)
      read_field_end
    end
    read_struct_end
  when Types::MAP
    ktype, vtype, size = read_map_begin
    size.times do
      skip(ktype)
      skip(vtype)
    end
    read_map_end
  when Types::SET
    etype, size = read_set_begin
    size.times do
      skip(etype)
    end
    read_set_end
  when Types::LIST
    etype, size = read_list_begin
    size.times do
      skip(etype)
    end
    read_list_end
  end
end

#write_bool(bool) ⇒ Object

Raises:

  • (NotImplementedError) 


93
94
95
 
# File 'lib/thrift/protocol/base_protocol.rb', line 93

def write_bool(bool)
  raise NotImplementedError
end

#write_byte(byte) ⇒ Object

Raises:

  • (NotImplementedError) 


97
98
99
 
# File 'lib/thrift/protocol/base_protocol.rb', line 97

def write_byte(byte)
  raise NotImplementedError
end

#write_double(dub) ⇒ Object

Raises:

  • (NotImplementedError) 


113
114
115
 
# File 'lib/thrift/protocol/base_protocol.rb', line 113

def write_double(dub)
  raise NotImplementedError
end

#write_field(name, type, fid, value) ⇒ Object 



195
196
197
198
199
 
# File 'lib/thrift/protocol/base_protocol.rb', line 195

def write_field(name, type, fid, value)
  write_field_begin(name, type, fid)
  write_type(type, value)
  write_field_end
end

#write_field_begin(name, type, id) ⇒ Object

Raises:

  • (NotImplementedError) 


65
66
67
 
# File 'lib/thrift/protocol/base_protocol.rb', line 65

def write_field_begin(name, type, id)
  raise NotImplementedError
end

#write_field_end ⇒ Object 



69
 
# File 'lib/thrift/protocol/base_protocol.rb', line 69

def write_field_end; nil; end

#write_field_stop ⇒ Object

Raises:

  • (NotImplementedError) 


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

def write_field_stop
  raise NotImplementedError
end

#write_i16(i16) ⇒ Object

Raises:

  • (NotImplementedError) 


101
102
103
 
# File 'lib/thrift/protocol/base_protocol.rb', line 101

def write_i16(i16)
  raise NotImplementedError
end

#write_i32(i32) ⇒ Object

Raises:

  • (NotImplementedError) 


105
106
107
 
# File 'lib/thrift/protocol/base_protocol.rb', line 105

def write_i32(i32)
  raise NotImplementedError
end

#write_i64(i64) ⇒ Object

Raises:

  • (NotImplementedError) 


109
110
111
 
# File 'lib/thrift/protocol/base_protocol.rb', line 109

def write_i64(i64)
  raise NotImplementedError
end

#write_list_begin(etype, size) ⇒ Object

Raises:

  • (NotImplementedError) 


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

def write_list_begin(etype, size)
  raise NotImplementedError
end

#write_list_end ⇒ Object 



85
 
# File 'lib/thrift/protocol/base_protocol.rb', line 85

def write_list_end; nil; end

#write_map_begin(ktype, vtype, size) ⇒ Object

Raises:

  • (NotImplementedError) 


75
76
77
 
# File 'lib/thrift/protocol/base_protocol.rb', line 75

def write_map_begin(ktype, vtype, size)
  raise NotImplementedError
end

#write_map_end ⇒ Object 



79
 
# File 'lib/thrift/protocol/base_protocol.rb', line 79

def write_map_end; nil; end

#write_message_begin(name, type, seqid) ⇒ Object

Raises:

  • (NotImplementedError) 


53
54
55
 
# File 'lib/thrift/protocol/base_protocol.rb', line 53

def write_message_begin(name, type, seqid)
  raise NotImplementedError
end

#write_message_end ⇒ Object 



57
 
# File 'lib/thrift/protocol/base_protocol.rb', line 57

def write_message_end; nil; end

#write_set_begin(etype, size) ⇒ Object

Raises:

  • (NotImplementedError) 


87
88
89
 
# File 'lib/thrift/protocol/base_protocol.rb', line 87

def write_set_begin(etype, size)
  raise NotImplementedError
end

#write_set_end ⇒ Object 



91
 
# File 'lib/thrift/protocol/base_protocol.rb', line 91

def write_set_end; nil; end

#write_string(str) ⇒ Object

Writes a Thrift String. In Ruby 1.9+, the String passed will be transcoded to UTF-8.

str - The String to write.

Raises EncodingError if the transcoding to UTF-8 fails.

Returns nothing.

Raises:

  • (NotImplementedError) 


124
125
126
 
# File 'lib/thrift/protocol/base_protocol.rb', line 124

def write_string(str)
  raise NotImplementedError
end

#write_struct_begin(name) ⇒ Object

Raises:

  • (NotImplementedError) 


59
60
61
 
# File 'lib/thrift/protocol/base_protocol.rb', line 59

def write_struct_begin(name)
  raise NotImplementedError
end

#write_struct_end ⇒ Object 



63
 
# File 'lib/thrift/protocol/base_protocol.rb', line 63

def write_struct_end; nil; end

#write_type(type, value) ⇒ Object 



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/thrift/protocol/base_protocol.rb', line 201

def write_type(type, value)
  case type
  when Types::BOOL
    write_bool(value)
  when Types::BYTE
    write_byte(value)
  when Types::DOUBLE
    write_double(value)
  when Types::I16
    write_i16(value)
  when Types::I32
    write_i32(value)
  when Types::I64
    write_i64(value)
  when Types::STRING
    write_string(value)
  when Types::STRUCT
    value.write(self)
  else
    raise NotImplementedError
  end
end