Automatic generation produced by ISE Eiffel
note description: "Class defining an Eiffel thread of execution using an agent for its internal action." legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2017-03-30 03:54:40 -0800 (Thu, 30 Mar 2017) $" revision: "$Revision: 100070 $" class interface WORKER_THREAD create make (a_action: PROCEDURE) -- Create worker thread for a_action. require thread_capable: {PLATFORM}.is_thread_capable make_with_procedure (a_action: PROCEDURE) -- Create worker thread for a_action. require thread_capable: {PLATFORM}.is_thread_capable feature -- Initialization execute_procedure -- Routine executed when thread is launched. feature -- Access current_thread_id: POINTER -- Thread identifier of the Current thread -- (from THREAD_ENVIRONMENT) generating_type: TYPE [detachable WORKER_THREAD] -- Type of current object -- (type of which it is a direct instance) -- (from ANY) ensure -- from ANY generating_type_not_void: Result /= Void generator: STRING_8 -- Name of current object's generating class -- (base class of the type of which it is a direct instance) -- (from ANY) ensure -- from ANY generator_not_void: Result /= Void generator_not_empty: not Result.is_empty terminated: BOOLEAN -- True if the thread has terminated. -- (from THREAD) thread_id: POINTER -- Thread-id of the current thread object. -- (from THREAD) feature -- Comparison frozen deep_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void -- or attached to isomorphic object structures? -- (from ANY) ensure -- from ANY instance_free: class shallow_implies_deep: standard_equal (a, b) implies Result both_or_none_void: (a = Void) implies (Result = (b = Void)) same_type: (Result and (a /= Void)) implies (b /= Void and then a.same_type (b)) symmetric: Result implies deep_equal (b, a) frozen equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void or attached -- to objects considered equal? -- (from ANY) ensure -- from ANY instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.is_equal (b)) frozen is_deep_equal alias "≡≡≡" (other: WORKER_THREAD): BOOLEAN -- Are Current and other attached to isomorphic object structures? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY shallow_implies_deep: standard_is_equal (other) implies Result same_type: Result implies same_type (other) symmetric: Result implies other.is_deep_equal (Current) is_equal (other: WORKER_THREAD): BOOLEAN -- Is other attached to an object considered -- equal to current object? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY symmetric: Result implies other ~ Current consistent: standard_is_equal (other) implies Result frozen standard_equal (a: detachable ANY; b: like arg #1): BOOLEAN -- Are a and b either both void or attached to -- field-by-field identical objects of the same type? -- Always uses default object comparison criterion. -- (from ANY) ensure -- from ANY instance_free: class definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.standard_is_equal (b)) frozen standard_is_equal alias "≜" (other: WORKER_THREAD): BOOLEAN -- Is other attached to an object of the same type -- as current object, and field-by-field identical to it? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY same_type: Result implies same_type (other) symmetric: Result implies other.standard_is_equal (Current) feature -- Status report conforms_to (other: ANY): BOOLEAN -- Does type of current object conform to type -- of other (as per Eiffel: The Language, chapter 13)? -- (from ANY) require -- from ANY other_not_void: other /= Void is_exit_supported: BOOLEAN -- Can `exit` be called? -- (from THREAD) ensure -- from THREAD is_class: class is_last_launch_successful: BOOLEAN -- Was the last call to `launch` or `launch_with_attributes` in current thread -- of execution successful? -- (from THREAD) is_launchable: BOOLEAN -- Can we launch a new thread? -- (from THREAD) same_type (other: ANY): BOOLEAN -- Is type of current object identical to type of other? -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY definition: Result = (conforms_to (other) and other.conforms_to (Current)) feature -- Duplication copy (other: WORKER_THREAD) -- Update current object using fields of object attached -- to other, so as to yield equal objects. -- (from ANY) require -- from ANY other_not_void: other /= Void type_identity: same_type (other) ensure -- from ANY is_equal: Current ~ other frozen deep_copy (other: WORKER_THREAD) -- Effect equivalent to that of: -- `copy` (other . `deep_twin`) -- (from ANY) require -- from ANY other_not_void: other /= Void ensure -- from ANY deep_equal: deep_equal (Current, other) frozen deep_twin: WORKER_THREAD -- New object structure recursively duplicated from Current. -- (from ANY) ensure -- from ANY deep_twin_not_void: Result /= Void deep_equal: deep_equal (Current, Result) frozen standard_copy (other: WORKER_THREAD) -- Copy every field of other onto corresponding field -- of current object. -- (from ANY) require -- from ANY other_not_void: other /= Void type_identity: same_type (other) ensure -- from ANY is_standard_equal: standard_is_equal (other) frozen standard_twin: WORKER_THREAD -- New object field-by-field identical to other. -- Always uses default copying semantics. -- (from ANY) ensure -- from ANY standard_twin_not_void: Result /= Void equal: standard_equal (Result, Current) frozen twin: WORKER_THREAD -- New object equal to Current -- `twin` calls `copy`; to change copying/twinning semantics, redefine `copy`. -- (from ANY) ensure -- from ANY twin_not_void: Result /= Void is_equal: Result ~ Current feature -- Basic operations frozen default: detachable WORKER_THREAD -- Default value of object's type -- (from ANY) frozen default_pointer: POINTER -- Default value of type POINTER -- (Avoid the need to write p.`default` for -- some p of type POINTER.) -- (from ANY) ensure -- from ANY instance_free: class default_rescue -- Process exception for routines with no Rescue clause. -- (Default: do nothing.) -- (from ANY) frozen do_nothing -- Execute a null action. -- (from ANY) ensure -- from ANY instance_free: class exit -- Exit calling thread. Must be called from the thread itself. -- (from THREAD) require -- from THREAD is_exit_supported: is_exit_supported self: current_thread_id = thread_id frozen launch -- Initialize a new thread running execute. -- Set `is_last_launch_successful` to True if successful, False otherwise. -- (from THREAD) require -- from THREAD thread_capable: {PLATFORM}.is_thread_capable is_launchable: is_launchable frozen launch_with_attributes (attr: THREAD_ATTRIBUTES) -- Initialize a new thread running execute, using attributes. -- Set `is_last_launch_successful` to True if successful, False otherwise. -- (from THREAD) require -- from THREAD thread_capable: {PLATFORM}.is_thread_capable is_launchable: is_launchable sleep (nanoseconds: INTEGER_64) -- Suspend thread execution for interval specified in -- nanoseconds (1 nanosecond = 10^(-9) second). -- (from THREAD) require -- from THREAD self: current_thread_id = thread_id non_negative_nanoseconds: nanoseconds >= 0 feature -- Output Io: STD_FILES -- Handle to standard file setup -- (from ANY) ensure -- from ANY instance_free: class io_not_void: Result /= Void out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY out_not_void: Result /= Void print (o: detachable ANY) -- Write terse external representation of o -- on standard output. -- (from ANY) ensure -- from ANY instance_free: class frozen tagged_out: STRING_8 -- New string containing terse printable representation -- of current object -- (from ANY) ensure -- from ANY tagged_out_not_void: Result /= Void feature -- Platform Operating_environment: OPERATING_ENVIRONMENT -- Objects available from the operating system -- (from ANY) ensure -- from ANY instance_free: class operating_environment_not_void: Result /= Void feature -- Synchronization join -- The calling thread waits for the current child thread to terminate. -- (from THREAD) join_all -- The calling thread waits for all other threads to terminate. -- (from THREAD_CONTROL) join_with_timeout (a_timeout_ms: NATURAL_64): BOOLEAN -- The calling thread waits for the current child thread to -- terminate for at most a_timeout_ms milliseconds. -- True if wait terminates within a_timeout_ms, False otherwise. -- (from THREAD) yield -- The calling thread yields its execution in favor of another -- thread for an OS specific amount of time. -- (from THREAD_CONTROL) invariant -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note copyright: "Copyright (c) 1984-2017, Eiffel Software and others" license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)" source: "[ Eiffel Software 5949 Hollister Ave., Goleta, CA 93117 USA Telephone 805-685-1006, Fax 805-685-6869 Website http://www.eiffel.com Customer support http://support.eiffel.com ]" end -- class WORKER_THREAD -- Generated by Eiffel Studio --
For more details: eiffel.org