module Qpid::Proton::Util::SWIGClassHelper
@private Class methods to help wrapper classes define forwarding methods to proton-C functions
The extending class must define PROTON_METHOD_PREFIX, the functions here make it easy to define ruby methods to forward calls to C functions.
Constants
- RBCTX
Public Instance Methods
fetch_instance(impl, attachment_method = nil)
click to toggle source
Retrieves the wrapper object with the supplied Proton
struct.
@param impl [Object] The wrapper for the Proton
struct. @param attachment_method [Symbol] The Proton
attachment method.
@return [Object] The Ruby wrapper object.
# File lib/util/wrapper.rb, line 87 def fetch_instance(impl, attachment_method = nil) # if the impl has a wrapper already attached, then return it if impl.instance_variable_defined?(:@proton_wrapper) return impl.instance_variable_get(:@proton_wrapper) end unless attachment_method.nil? record = Cproton.__send__(attachment_method, impl) rbkey = Cproton.pni_void2rbkey(Cproton.pn_record_get(record, RBCTX)) # if we don't have a key, then we don't have an object return nil if rbkey.nil? registry_key = Cproton.Pn_rbkey_get_key_value(rbkey) else registry_key = get_key(impl) end # if the object's not in the registry then return return nil unless @@registry.has_key?(registry_key) result = @@registry[registry_key] # result = nil unless result.weakref_alive? if result.nil? raise Qpid::Proton::ProtonError.new("missing object for key=#{registry_key}") else # update the impl since the Swig wrapper for it may have changed result.impl = impl end return result end
get_key(impl)
click to toggle source
@private
# File lib/util/wrapper.rb, line 54 def get_key(impl) ("%032x" % Cproton.pni_address_of(impl)) end
proton_caller(*names)
click to toggle source
# File lib/util/wrapper.rb, line 37 def proton_caller(*names) names.each { |name| proton_forward(name, name) }; end
proton_forward(name, pn_name)
click to toggle source
Define ruby method name
to forward arguments to CProton.PROTON_METHOD_PREFIX_+pn_name+(@impl, …)
# File lib/util/wrapper.rb, line 31 def proton_forward(name, pn_name) pn_name = pn_name[0..-2] if pn_name.to_s.end_with? "?" # Drop trailing ? for ruby bool methods pn_name = "#{self::PROTON_METHOD_PREFIX}_#{pn_name}".to_sym define_method(name.to_sym) { |*args| Cproton.__send__(pn_name, @impl, *args) } end
proton_get(*names)
click to toggle source
# File lib/util/wrapper.rb, line 39 def proton_get(*names) names.each { |name| proton_forward(name, "get_#{name}") }; end
proton_is(*names)
click to toggle source
# File lib/util/wrapper.rb, line 40 def proton_is(*names) names.each { |name| proton_forward("#{name}?", "is_#{name}") }; end
proton_set(*names)
click to toggle source
# File lib/util/wrapper.rb, line 38 def proton_set(*names) names.each { |name| proton_forward("#{name}=", "set_#{name}") }; end
proton_set_get(*names)
click to toggle source
# File lib/util/wrapper.rb, line 41 def proton_set_get(*names) names.each { |name| proton_get(name); proton_set(name) }; end
proton_set_is(*names)
click to toggle source
# File lib/util/wrapper.rb, line 42 def proton_set_is(*names) names.each { |name| proton_is(name); proton_set(name) }; end
store_instance(object, attachment_method = nil)
click to toggle source
@private Stores the given object for later retrieval.
@param object [Object] The object. @param attachment_method [Symbol] The Proton
attachment method.
# File lib/util/wrapper.rb, line 64 def store_instance(object, attachment_method = nil) # ensure the impl has a reference to the wrapper object object.impl.instance_eval { @proton_wrapper = object } registry_key = get_key(object.impl) unless attachment_method.nil? record = Cproton.__send__(attachment_method, object.impl) rbkey = Cproton.Pn_rbkey_new Cproton.Pn_rbkey_set_registry(rbkey, Cproton.pn_rb2void(Qpid::Proton::Util::Wrapper.registry)) Cproton.Pn_rbkey_set_method(rbkey, "delete") Cproton.Pn_rbkey_set_key_value(rbkey, registry_key) Cproton.pn_record_def(record, RBCTX, Cproton.Pn_rbkey__class()); Cproton.pn_record_set(record, RBCTX, rbkey) end @@registry[registry_key] = object end