Contents

require 'thread'

module Rex

###
#
# This module provides a uniform reference counted interface for classes to
# use.
#
###
module Ref

	#
	# Initializes the reference count to one.
	#
	def refinit
		@_references       = 1
		@_references_mutex = Mutex.new

		self
	end

	#
	# Increments the total number of references.
	#
	def ref
		@_references_mutex.synchronize {
			@_references += 1
		}

		self
	end

	#
	# Decrements the total number of references.  If the reference count
	# reaches zero, true is returned.  Otherwise, false is returned.
	#
	def deref
		@_references_mutex.synchronize {
			if ((@_references -= 1) == 0)
				cleanup

				true
			else
				false
			end
		}
	end

	#
	# Called to clean up resources once the ref count drops to zero.
	#
	def cleanup
	end

end
end

Version data entries

43 entries across 43 versions & 1 rubygems

Version	Path
librex-0.0.35	lib/rex/sync/ref.rb
librex-0.0.34	lib/rex/sync/ref.rb
librex-0.0.33	lib/rex/sync/ref.rb
librex-0.0.32	lib/rex/sync/ref.rb
librex-0.0.31	lib/rex/sync/ref.rb
librex-0.0.30	lib/rex/sync/ref.rb
librex-0.0.29	lib/rex/sync/ref.rb
librex-0.0.28	lib/rex/sync/ref.rb
librex-0.0.27	lib/rex/sync/ref.rb
librex-0.0.26	lib/rex/sync/ref.rb
librex-0.0.25	lib/rex/sync/ref.rb
librex-0.0.23	lib/rex/sync/ref.rb
librex-0.0.21	lib/rex/sync/ref.rb
librex-0.0.19	lib/rex/sync/ref.rb
librex-0.0.17	lib/rex/sync/ref.rb
librex-0.0.13	lib/rex/sync/ref.rb
librex-0.0.12	lib/rex/sync/ref.rb
librex-0.0.7	lib/rex/sync/ref.rb
librex-0.0.6	lib/rex/sync/ref.rb
librex-0.0.5	lib/rex/sync/ref.rb