Automatic generation produced by ISE Eiffel
note description: "[ cURL curl_easy_setopt callback functions' Eiffel wrappers. We need this class since cURL need a c function pointer as value but Eiffel function need frist parameter of any funciton call is object address. Client programmers can inherit this class to fit their needs. Note: descendants of this class have to call `set_object_and_function_address`, otherwise cURL would not know how to call Eiffel features (such as `write_function`). See example: $ISE_LIBRARY\examples\cURL\upload_and_read_function See http://curl.haxx.se/libcurl/c/curl_easy_setopt.html for libcurl documentation ]" status: "See notice at end of class." legal: "See notice at end of class." date: "$Date: 2018-05-17 10:48:59 -0800 (Thu, 17 May 2018) $" revision: "$Revision: 101747 $" deferred class interface CURL_FUNCTION feature -- Access generating_type: TYPE [detachable CURL_FUNCTION] -- 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 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: CURL_FUNCTION): 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: CURL_FUNCTION): 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: CURL_FUNCTION): 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 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: CURL_FUNCTION) -- 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: CURL_FUNCTION) -- 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: CURL_FUNCTION -- 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: CURL_FUNCTION) -- 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: CURL_FUNCTION -- 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: CURL_FUNCTION -- 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 CURL_FUNCTION -- 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 feature -- Implementation dispose -- Wean Current feature -- Interactive with C c_set_debug_function (a_setopt_api: POINTER; a_curl_handle: POINTER) -- Setting CURLOPT_DEBUGFUNCTION option of a_curl_handle. -- We need this function since cURL need a c function pointer as value. require api_exists: not a_setopt_api.is_default_pointer exists: not a_curl_handle.is_default_pointer c_set_progress_function (a_setopt_api: POINTER; a_curl_handle: POINTER) -- Setting CURLOPT_PROGRESSFUNCTION option of a_curl_handle. -- We need this function since cURL need a c function pointer as value. require exists: not a_setopt_api.is_default_pointer c_set_read_function (a_setopt_api: POINTER; a_curl_handle: POINTER) -- Setting CURLOPT_READFUNCTION option of a_curl_handle. -- We need this function since cURL need a c function pointer as value. require api_exists: not a_setopt_api.is_default_pointer c_set_write_function (a_setopt_api: POINTER; a_curl_handle: POINTER) -- Setting CURLOPT_WRITEFUNCTION option of a_curl_handle. -- We need this function since cURL need a c function pointer as value. require api_exists: not a_setopt_api.is_default_pointer set_object_and_function_address -- Set object and function addresses. -- Call this feature before call `c_set_progress_function`, `c_set_debug_function` and c_set_write_function, c_set_read_function. 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 -- cURL curl_easy_setopt functions debug_function (a_curl_handle: POINTER; a_curl_infotype: INTEGER_32; a_char_pointer: POINTER; a_size: INTEGER_32; a_object_id: POINTER): INTEGER_32 -- Function correspond to {CURL_OPT_CONSTANTS}.curlopt_debugfunction -- Note, pass a {IDENTIFIED}.object_id as a_object_id value is helpful since we can't directly pass an Eiffel Object address which -- may changed during GC. require vaild: (create {CURL_INFO_TYPE} end).is_valid (a_curl_infotype) progress_function (a_object_id: POINTER; a_download_total, a_download_now, a_upload_total, a_upload_now: REAL_64): INTEGER_32 -- Function correspond to {CURL_OPT_CONSTANTS}.curlopt_progressfunction -- Note, pass a {IDENTIFIED}.object_id as a_object_id value is helpful since we can't directly pass an Eiffel Object address which -- may changed during GC. read_function (a_data_pointer: POINTER; a_size, a_nmemb: INTEGER_32; a_object_id: POINTER): INTEGER_32 -- Function called by libcurl as soon as it needs to read data in order to send it to the peer. -- The data area pointed at by the pointer a_data_pointer may be filled with at most -- a_size multiplied with a_nmemb number of bytes. -- Returns the actual number of bytes stored in that memory area. -- Returning 0 will signal end-of-file to the library and cause it to stop the current transfer. -- -- Function corresponds to {CURL_OPT_CONSTANTS}.curlopt_readfunction -- Note, pass a {IDENTIFIED}.object_id as a_object_id value is helpful since we can't directly pass an Eiffel Object address which -- may changed during GC. write_function (a_data_pointer: POINTER; a_size, a_nmemb: INTEGER_32; a_object_id: POINTER): INTEGER_32 -- Function called by libcurl as soon as there is data received that needs to be saved. -- The size of the data pointed to by a_data_pointer is a_size multiplied with a_nmemb, it will not be null terminated. -- Returns the number of bytes actually taken care of -- -- Function corresponds to {CURL_OPT_CONSTANTS}.curlopt_writefunction -- Note, pass a {IDENTIFIED}.object_id as a_object_id value is helpful since we can't directly pass an Eiffel Object address which -- may changed during GC. invariant -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note library: "cURL: Library of reusable components for Eiffel." copyright: "Copyright (c) 1984-2018, 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 CURL_FUNCTION -- Generated by Eiffel Studio --
For more details: eiffel.org