From: Kevin Clark <kclark@apache.org>
Date: Wed, 18 Jun 2008 00:53:28 +0000 (+0000)
Subject: rb: Move exceptions, types, processor, client, struct under Thrift module. Add consta... 
X-Git-Tag: 0.2.0~647
X-Git-Url: https://source.supwisdom.com/gerrit/gitweb?a=commitdiff_plain;h=97d2166a341657931e43adfe140ffeba48239de0;p=common%2Fthrift.git

rb: Move exceptions, types, processor, client, struct under Thrift module. Add constants for backwards compatability


git-svn-id: https://svn.apache.org/repos/asf/incubator/thrift/trunk@668902 13f79535-47bb-0310-9956-ffa450edef68
---

diff --git a/lib/rb/lib/thrift.rb b/lib/rb/lib/thrift.rb
index 99a7568f..14d33cf6 100644
--- a/lib/rb/lib/thrift.rb
+++ b/lib/rb/lib/thrift.rb
@@ -11,10 +11,21 @@
 $:.unshift File.dirname(__FILE__)
 
 require 'thrift/exceptions'
+TException = Thrift::Exception
+TApplicationException = Thrift::ApplicationException
+
 require 'thrift/types'
+TType = Thrift::Types
+TMessageType = Thrift::MessageTypes
+
 require 'thrift/tprocessor'
+TProcessor = Thrift::Processor
+
 require 'thrift/thrift_client'
+ThriftClient = Thrift::Client
+
 require 'thrift/thrift_struct'
+ThriftStruct = Thrift::Struct
 
 require 'thrift/protocol/tprotocol'
 
diff --git a/lib/rb/lib/thrift/exceptions.rb b/lib/rb/lib/thrift/exceptions.rb
index 8af5dce5..673e9e3b 100644
--- a/lib/rb/lib/thrift/exceptions.rb
+++ b/lib/rb/lib/thrift/exceptions.rb
@@ -1,69 +1,71 @@
-class TException < StandardError
-  def initialize(message)
-    super(message)
-    @message = message
-  end
+module Thrift
+  class Exception < StandardError
+    def initialize(message)
+      super(message)
+      @message = message
+    end
 
-  attr_reader :message
-end
+    attr_reader :message
+  end
 
-class TApplicationException < TException
+  class ApplicationException < Exception
 
-  UNKNOWN = 0
-  UNKNOWN_METHOD = 1
-  INVALID_MESSAGE_TYPE = 2
-  WRONG_METHOD_NAME = 3
-  BAD_SEQUENCE_ID = 4
-  MISSING_RESULT = 5
+    UNKNOWN = 0
+    UNKNOWN_METHOD = 1
+    INVALID_MESSAGE_TYPE = 2
+    WRONG_METHOD_NAME = 3
+    BAD_SEQUENCE_ID = 4
+    MISSING_RESULT = 5
 
-  attr_reader :type
+    attr_reader :type
 
-  def initialize(type=UNKNOWN, message=nil)
-    super(message)
-    @type = type
-  end
+    def initialize(type=UNKNOWN, message=nil)
+      super(message)
+      @type = type
+    end
 
-  def read(iprot)
-    iprot.readStructBegin()
-    while true
-      fname, ftype, fid = iprot.readFieldBegin()
-      if (ftype === TType::STOP)
-        break
-      end
-      if (fid == 1)
-        if (ftype === TType::STRING)
-          @message = iprot.readString();
-        else
-          iprot.skip(ftype)
+    def read(iprot)
+      iprot.readStructBegin()
+      while true
+        fname, ftype, fid = iprot.readFieldBegin()
+        if (ftype === TType::STOP)
+          break
         end
-      elsif (fid == 2)
-        if (ftype === TType::I32)
-          @type = iprot.readI32();
+        if (fid == 1)
+          if (ftype === TType::STRING)
+            @message = iprot.readString();
+          else
+            iprot.skip(ftype)
+          end
+        elsif (fid == 2)
+          if (ftype === TType::I32)
+            @type = iprot.readI32();
+          else
+            iprot.skip(ftype)
+          end
         else
           iprot.skip(ftype)
         end
-      else
-        iprot.skip(ftype)
+        iprot.readFieldEnd()
       end
-      iprot.readFieldEnd()
+      iprot.readStructEnd()
     end
-    iprot.readStructEnd()
-  end
 
-  def write(oprot)
-    oprot.writeStructBegin('TApplicationException')
-    if (@message != nil)
-      oprot.writeFieldBegin('message', TType::STRING, 1)
-      oprot.writeString(@message)
-      oprot.writeFieldEnd()
-    end
-    if (@type != nil)
-      oprot.writeFieldBegin('type', TType::I32, 2)
-      oprot.writeI32(@type)
-      oprot.writeFieldEnd()
+    def write(oprot)
+      oprot.writeStructBegin('TApplicationException')
+      if (@message != nil)
+        oprot.writeFieldBegin('message', TType::STRING, 1)
+        oprot.writeString(@message)
+        oprot.writeFieldEnd()
+      end
+      if (@type != nil)
+        oprot.writeFieldBegin('type', TType::I32, 2)
+        oprot.writeI32(@type)
+        oprot.writeFieldEnd()
+      end
+      oprot.writeFieldStop()
+      oprot.writeStructEnd()
     end
-    oprot.writeFieldStop()
-    oprot.writeStructEnd()
-  end
 
-end
+  end
+end
\ No newline at end of file
diff --git a/lib/rb/lib/thrift/thrift.rb b/lib/rb/lib/thrift/thrift.rb
index 6a168a14..4cf5fc05 100644
--- a/lib/rb/lib/thrift/thrift.rb
+++ b/lib/rb/lib/thrift/thrift.rb
@@ -1,2 +1,2 @@
 # This file kept for backwards compatability
-require File.join(File.dirname(__FILE__), '../thrift')
\ No newline at end of file
+require File.join(File.dirname(__FILE__), '../thrift')
diff --git a/lib/rb/lib/thrift/thrift_client.rb b/lib/rb/lib/thrift/thrift_client.rb
index 2be0af3d..168c4323 100644
--- a/lib/rb/lib/thrift/thrift_client.rb
+++ b/lib/rb/lib/thrift/thrift_client.rb
@@ -1,36 +1,38 @@
-module ThriftClient
-  def initialize(iprot, oprot=nil)
-    @iprot = iprot
-    @oprot = oprot || iprot
-    @seqid = 0
-  end
-
-  def send_message(name, args_class, args = {})
-    @oprot.writeMessageBegin(name, TMessageType::CALL, @seqid)
-    data = args_class.new
-    args.each do |k, v|
-      data.send("#{k.to_s}=", v)
+module Thrift
+  module Client
+    def initialize(iprot, oprot=nil)
+      @iprot = iprot
+      @oprot = oprot || iprot
+      @seqid = 0
     end
-    data.write(@oprot)
-    @oprot.writeMessageEnd()
-    @oprot.trans.flush()
-  end
 
-  def receive_message(result_klass)
-    fname, mtype, rseqid = @iprot.readMessageBegin()
-    handle_exception(mtype)
-    result = result_klass.new
-    result.read(@iprot)
-    @iprot.readMessageEnd()
-    return result
-  end
+    def send_message(name, args_class, args = {})
+      @oprot.writeMessageBegin(name, TMessageType::CALL, @seqid)
+      data = args_class.new
+      args.each do |k, v|
+        data.send("#{k.to_s}=", v)
+      end
+      data.write(@oprot)
+      @oprot.writeMessageEnd()
+      @oprot.trans.flush()
+    end
 
-  def handle_exception(mtype)
-    if mtype == TMessageType::EXCEPTION
-      x = TApplicationException.new()
-      x.read(@iprot)
+    def receive_message(result_klass)
+      fname, mtype, rseqid = @iprot.readMessageBegin()
+      handle_exception(mtype)
+      result = result_klass.new
+      result.read(@iprot)
       @iprot.readMessageEnd()
-      raise x
+      return result
+    end
+
+    def handle_exception(mtype)
+      if mtype == TMessageType::EXCEPTION
+        x = TApplicationException.new()
+        x.read(@iprot)
+        @iprot.readMessageEnd()
+        raise x
+      end
     end
   end
 end
diff --git a/lib/rb/lib/thrift/thrift_struct.rb b/lib/rb/lib/thrift/thrift_struct.rb
index 5947038c..04b581ff 100644
--- a/lib/rb/lib/thrift/thrift_struct.rb
+++ b/lib/rb/lib/thrift/thrift_struct.rb
@@ -1,135 +1,137 @@
-module ThriftStruct
-  def initialize(d={})
-    each_field do |fid, type, name, default|
-      instance_variable_set("@#{name}", d[name.to_s] || d[name.intern] || default)
+module Thrift
+  module Struct
+    def initialize(d={})
+      each_field do |fid, type, name, default|
+        instance_variable_set("@#{name}", d[name.to_s] || d[name.intern] || default)
+      end
     end
-  end
 
-  def struct_fields
-    self.class.const_get(:FIELDS)
-  end
+    def struct_fields
+      self.class.const_get(:FIELDS)
+    end
 
-  def each_field
-    struct_fields.each do |fid, data|
-      yield fid, data[:type], data[:name], data[:default]
+    def each_field
+      struct_fields.each do |fid, data|
+        yield fid, data[:type], data[:name], data[:default]
+      end
     end
-  end
 
-  def read(iprot)
-    iprot.readStructBegin()
-    loop do
-      fname, ftype, fid = iprot.readFieldBegin()
-      break if (ftype === TType::STOP)
-      handle_message(iprot, fid, ftype)
-      iprot.readFieldEnd()
+    def read(iprot)
+      iprot.readStructBegin()
+      loop do
+        fname, ftype, fid = iprot.readFieldBegin()
+        break if (ftype === TType::STOP)
+        handle_message(iprot, fid, ftype)
+        iprot.readFieldEnd()
+      end
+      iprot.readStructEnd()
     end
-    iprot.readStructEnd()
-  end
 
-  def write(oprot)
-    oprot.writeStructBegin(self.class.name)
-    each_field do |fid, type, name|
-      if ((value = instance_variable_get("@#{name}")) != nil)
-        if is_container? type
-          oprot.writeFieldBegin(name, type, fid)
-          write_container(oprot, value, struct_fields[fid])
-          oprot.writeFieldEnd
-        else
-          oprot.write_field(name, type, fid, value)
+    def write(oprot)
+      oprot.writeStructBegin(self.class.name)
+      each_field do |fid, type, name|
+        if ((value = instance_variable_get("@#{name}")) != nil)
+          if is_container? type
+            oprot.writeFieldBegin(name, type, fid)
+            write_container(oprot, value, struct_fields[fid])
+            oprot.writeFieldEnd
+          else
+            oprot.write_field(name, type, fid, value)
+          end
         end
       end
+      oprot.writeFieldStop()
+      oprot.writeStructEnd()
     end
-    oprot.writeFieldStop()
-    oprot.writeStructEnd()
-  end
 
-  protected
+    protected
 
-  def handle_message(iprot, fid, ftype)
-    field = struct_fields[fid]
-    if field && field[:type] == ftype
-      value = read_field(iprot, field)
-      instance_variable_set("@#{field[:name]}", value)
-    else
-      iprot.skip(ftype)
+    def handle_message(iprot, fid, ftype)
+      field = struct_fields[fid]
+      if field && field[:type] == ftype
+        value = read_field(iprot, field)
+        instance_variable_set("@#{field[:name]}", value)
+      else
+        iprot.skip(ftype)
+      end
     end
-  end
 
-  def read_field(iprot, field = {})
-    if field[:type] == TType::STRUCT
-      value = field[:class].new
-      value.read(iprot)
-    elsif field[:type] == TType::MAP
-      key_type, val_type, size = iprot.readMapBegin
-      value = {}
-      size.times do
-        k = read_field(iprot, field_info(field[:key]))
-        v = read_field(iprot, field_info(field[:value]))
-        value[k] = v
-      end
-      iprot.readMapEnd
-    elsif field[:type] == TType::LIST
-      e_type, size = iprot.readListBegin
-      value = Array.new(size) do |n|
-        read_field(iprot, field_info(field[:element]))
-      end
-      iprot.readListEnd
-    elsif field[:type] == TType::SET
-      e_type, size = iprot.readSetBegin
-      value = {}
-      size.times do
-        element = read_field(iprot, field_info(field[:element]))
-        value[element] = true
+    def read_field(iprot, field = {})
+      if field[:type] == TType::STRUCT
+        value = field[:class].new
+        value.read(iprot)
+      elsif field[:type] == TType::MAP
+        key_type, val_type, size = iprot.readMapBegin
+        value = {}
+        size.times do
+          k = read_field(iprot, field_info(field[:key]))
+          v = read_field(iprot, field_info(field[:value]))
+          value[k] = v
+        end
+        iprot.readMapEnd
+      elsif field[:type] == TType::LIST
+        e_type, size = iprot.readListBegin
+        value = Array.new(size) do |n|
+          read_field(iprot, field_info(field[:element]))
+        end
+        iprot.readListEnd
+      elsif field[:type] == TType::SET
+        e_type, size = iprot.readSetBegin
+        value = {}
+        size.times do
+          element = read_field(iprot, field_info(field[:element]))
+          value[element] = true
+        end
+        iprot.readSetEnd
+      else
+        value = iprot.read_type(field[:type])
       end
-      iprot.readSetEnd
-    else
-      value = iprot.read_type(field[:type])
+      value
     end
-    value
-  end
 
-  def write_data(oprot, value, field)
-    if is_container? field[:type]
-      write_container(oprot, value, field)
-    else
-      oprot.write_type(field[:type], value)
+    def write_data(oprot, value, field)
+      if is_container? field[:type]
+        write_container(oprot, value, field)
+      else
+        oprot.write_type(field[:type], value)
+      end
     end
-  end
 
-  def write_container(oprot, value, field = {})
-    if field[:type] == TType::MAP
-      oprot.writeMapBegin(field[:key][:type], field[:value][:type], value.size)
-      value.each do |k, v|
-        write_data(oprot, k, field[:key])
-        write_data(oprot, v, field[:value])
-      end
-      oprot.writeMapEnd
-    elsif field[:type] == TType::LIST
-      oprot.writeListBegin(field[:element][:type], value.size)
-      value.each do |elem|
-        write_data(oprot, elem, field[:element])
-      end
-      oprot.writeListEnd
-    elsif field[:type] == TType::SET
-      oprot.writeSetBegin(field[:element][:type], value.size)
-      value.each do |k, v|
-        write_data(oprot, k, field[:element])
+    def write_container(oprot, value, field = {})
+      if field[:type] == TType::MAP
+        oprot.writeMapBegin(field[:key][:type], field[:value][:type], value.size)
+        value.each do |k, v|
+          write_data(oprot, k, field[:key])
+          write_data(oprot, v, field[:value])
+        end
+        oprot.writeMapEnd
+      elsif field[:type] == TType::LIST
+        oprot.writeListBegin(field[:element][:type], value.size)
+        value.each do |elem|
+          write_data(oprot, elem, field[:element])
+        end
+        oprot.writeListEnd
+      elsif field[:type] == TType::SET
+        oprot.writeSetBegin(field[:element][:type], value.size)
+        value.each do |k, v|
+          write_data(oprot, k, field[:element])
+        end
+        oprot.writeSetEnd
+      else
+        raise "Not a container type: #{field[:type]}"
       end
-      oprot.writeSetEnd
-    else
-      raise "Not a container type: #{field[:type]}"
     end
-  end
 
-  def is_container?(type)
-    [TType::LIST, TType::MAP, TType::SET].include? type
-  end
+    def is_container?(type)
+      [TType::LIST, TType::MAP, TType::SET].include? type
+    end
 
-  def field_info(field)
-    { :type => field[:type],
-      :class => field[:class],
-      :key => field[:key],
-      :value => field[:value],
-      :element => field[:element] }
+    def field_info(field)
+      { :type => field[:type],
+        :class => field[:class],
+        :key => field[:key],
+        :value => field[:value],
+        :element => field[:element] }
+    end
   end
 end
diff --git a/lib/rb/lib/thrift/tprocessor.rb b/lib/rb/lib/thrift/tprocessor.rb
index 1a2c5a10..a234c615 100644
--- a/lib/rb/lib/thrift/tprocessor.rb
+++ b/lib/rb/lib/thrift/tprocessor.rb
@@ -1,36 +1,38 @@
-module TProcessor
-  def initialize(handler)
-    @handler = handler
-  end
+module Thrift
+  module Processor
+    def initialize(handler)
+      @handler = handler
+    end
 
-  def process(iprot, oprot)
-    name, type, seqid  = iprot.readMessageBegin()
-    if respond_to?("process_#{name}")
-      send("process_#{name}", seqid, iprot, oprot)
-      return true
-    else
-      iprot.skip(TType::STRUCT)
-      iprot.readMessageEnd()
-      x = TApplicationException.new(TApplicationException::UNKNOWN_METHOD, 'Unknown function '+name)
-      oprot.writeMessageBegin(name, TMessageType::EXCEPTION, seqid)
-        x.write(oprot)
-      oprot.writeMessageEnd()
-      oprot.trans.flush()
-      return
+    def process(iprot, oprot)
+      name, type, seqid  = iprot.readMessageBegin()
+      if respond_to?("process_#{name}")
+        send("process_#{name}", seqid, iprot, oprot)
+        return true
+      else
+        iprot.skip(TType::STRUCT)
+        iprot.readMessageEnd()
+        x = TApplicationException.new(TApplicationException::UNKNOWN_METHOD, 'Unknown function '+name)
+        oprot.writeMessageBegin(name, TMessageType::EXCEPTION, seqid)
+          x.write(oprot)
+        oprot.writeMessageEnd()
+        oprot.trans.flush()
+        return
+      end
     end
-  end
 
-  def read_args(iprot, args_class)
-    args = args_class.new
-    args.read(iprot)
-    iprot.readMessageEnd
-    args
-  end
+    def read_args(iprot, args_class)
+      args = args_class.new
+      args.read(iprot)
+      iprot.readMessageEnd
+      args
+    end
 
-  def write_result(result, oprot, name, seqid)
-    oprot.writeMessageBegin(name, TMessageType::REPLY, seqid)
-    result.write(oprot)
-    oprot.writeMessageEnd()
-    oprot.trans.flush()
+    def write_result(result, oprot, name, seqid)
+      oprot.writeMessageBegin(name, TMessageType::REPLY, seqid)
+      result.write(oprot)
+      oprot.writeMessageEnd()
+      oprot.trans.flush()
+    end
   end
 end
diff --git a/lib/rb/lib/thrift/types.rb b/lib/rb/lib/thrift/types.rb
index db13f255..2ff893f9 100644
--- a/lib/rb/lib/thrift/types.rb
+++ b/lib/rb/lib/thrift/types.rb
@@ -1,21 +1,23 @@
-module TType
-  STOP = 0
-  VOID = 1
-  BOOL = 2
-  BYTE = 3
-  DOUBLE = 4
-  I16 = 6
-  I32 = 8
-  I64 = 10
-  STRING = 11
-  STRUCT = 12
-  MAP = 13
-  SET = 14
-  LIST = 15
-end
+module Thrift
+  module Types
+    STOP = 0
+    VOID = 1
+    BOOL = 2
+    BYTE = 3
+    DOUBLE = 4
+    I16 = 6
+    I32 = 8
+    I64 = 10
+    STRING = 11
+    STRUCT = 12
+    MAP = 13
+    SET = 14
+    LIST = 15
+  end
 
-module TMessageType
-  CALL = 1
-  REPLY = 2
-  EXCEPTION = 3
-end
+  module MessageTypes
+    CALL = 1
+    REPLY = 2
+    EXCEPTION = 3
+  end
+end
\ No newline at end of file