Automatic generation produced by ISE Eiffel
indexing description: "[ Facilities for tuning up the garbage collection mechanism. This class may be used as ancestor by classes needing its facilities. ]" status: "See notice at end of class" date: "$Date: 2001-11-16 20:32:23 +0000 (Fri, 16 Nov 2001) $" revision: "$Revision: 51435 $" class interface MEMORY feature -- Access C_memory: INTEGER is 2 -- Code for the C memory managed -- by the garbage collector -- (from MEM_CONST) Eiffel_memory: INTEGER is 1 -- Code for the Eiffel memory managed -- by the garbage collector -- (from MEM_CONST) Full_collector: INTEGER is 0 -- Statistics for full collections -- (from MEM_CONST) Incremental_collector: INTEGER is 1 -- Statistics for incremental collections -- (from MEM_CONST) Total_memory: INTEGER is 0 -- Code for all the memory managed -- by the garbage collector -- (from MEM_CONST) feature -- Measurement gc_statistics (collector_type: INTEGER): GC_INFO -- Garbage collection information for collector_type. require type_ok: collector_type = full_collector or collector_type = incremental_collector memory_statistics (memory_type: INTEGER): MEM_INFO -- Memory usage information for memory_type require type_ok: memory_type = total_memory or memory_type = eiffel_memory or memory_type = c_memory feature -- Status report chunk_size: INTEGER -- Minimal size of a memory chunk. The run-time always -- allocates a multiple of this size. -- If the environment variable EIF_MEMORY_CHUNK -- is defined, it is set to the closest reasonable -- value from it. coalesce_period: INTEGER -- Period of full coalesce (in number of collections) -- If the environment variable EIF_FULL_COALESCE_PERIOD -- is defined, it is set to the closest reasonable -- value from it. -- If null, no full coalescing is launched. collecting: BOOLEAN -- Is garbage collection enabled? collection_period: INTEGER -- Period of full collection. -- If the environment variable EIF_FULL_COLLECTION_PERIOD -- is defined, it is set to the closest reasonable -- value from it. -- If null, no full collection is launched. generation_object_limit: INTEGER -- Maximum size of object in generational scavenge zone. -- If the environment variable EIF_GS_LIMIT -- is defined, it is set to the closest reasonable -- value from it. largest_coalesced_block: INTEGER -- Size of largest coalesced block since last call to -- largest_coalesced; 0 if none. max_mem: INTEGER -- Maximum amount of bytes the run-time can allocate. memory_threshold: INTEGER -- Minimum amount of bytes to be allocated before -- starting an automatic garbage collection. referers (an_object: ANY): ARRAY [ANY] -- Objects that refer to an_object. scavenge_zone_size: INTEGER -- Size of generational scavenge zone. -- If the environment variable EIF_MEMORY_SCAVENGE -- is defined, it is set to the closest reasonable -- value from it. tenure: INTEGER -- Maximum age of object before being considered -- as old (old objects are not scanned during -- partial collection). -- If the environment variable EIF_TENURE_MAX -- is defined, it is set to the closest reasonable -- value from it. feature -- Status setting allocate_compact -- Enter `memory' mode: will try to compact memory -- before requesting more from the operating system. allocate_fast -- Enter `speed' mode: will optimize speed of memory -- allocation rather than memory usage. allocate_tiny -- Enter `tiny' mode: will enter `memory' mode -- after having freed as much memory as possible. collection_off -- Disable garbage collection. collection_on -- Enable garbage collection. disable_time_accounting -- Disable GC time accounting (default). enable_time_accounting -- Enable GC time accouting, accessible in gc_statistics. set_coalesce_period (value: INTEGER) -- Set coalesce_period. Every value collection, -- the Garbage Collector will coalesce -- the whole memory. require positive_value: value >= 0 set_collection_period (value: INTEGER) -- Set collection_period. Every value collection, -- the Garbage collector will perform a collection -- on the whole memory (full collection), otherwise -- a simple partial collection is done. require positive_value: value >= 0 set_max_mem (value: INTEGER) -- Set the maximum amount of memory the run-time can allocate. require positive_value: value > 0 set_memory_threshold (value: INTEGER) -- Set a new memory_threshold in bytes. Whenever the memory -- allocated for Eiffel reaches this value, an automatic -- collection is performed. require positive_value: value > 0 feature -- Removal collect -- Force a partial collection cycle if garbage -- collection is enabled; do nothing otherwise. dispose -- Action to be executed just before garbage collection -- reclaims an object. -- Default version does nothing; redefine in descendants -- to perform specific dispose actions. Those actions -- should only take care of freeing external resources; -- they should not perform remote calls on other objects -- since these may also be dead and reclaimed. free (object: ANY) -- Free object, by-passing garbage collection. -- Erratic behavior will result if the object is still -- referenced. full_coalesce -- Coalesce the whole memory: merge adjacent free -- blocks to reduce fragmentation. Useful, when -- a lot of memory is allocated with garbage collector off. full_collect -- Force a full collection cycle if garbage -- collection is enabled; do nothing otherwise. mem_free (addr: POINTER) -- Free memory of object at addr. -- (Preferred interface is free.) invariant -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) indexing library: "[ EiffelBase: Library of reusable components for Eiffel. ]" status: "[ Copyright 1986-2001 Interactive Software Engineering (ISE). For ISE customers the original versions are an ISE product covered by the ISE Eiffel license and support agreements. ]" license: "[ EiffelBase may now be used by anyone as FREE SOFTWARE to develop any product, public-domain or commercial, without payment to ISE, under the terms of the ISE Free Eiffel Library License (IFELL) at http://eiffel.com/products/base/license.html. ]" source: "[ Interactive Software Engineering Inc. ISE Building 360 Storke Road, Goleta, CA 93117 USA Telephone 805-685-1006, Fax 805-685-6869 Electronic mail <info@eiffel.com> Customer support http://support.eiffel.com ]" info: "[ For latest info see award-winning pages: http://eiffel.com ]" end -- class MEMORY -- Generated by ISE Eiffel --
For more details: www.eiffel.com