Automatic generation produced by ISE Eiffel
note description: "A network socket address." legal: "See notice at end of class." status: "See notice at end of class." date: "$Date: 2020-05-19 06:37:01 -0800 (Tue, 19 May 2020) $" revision: "$Revision: 104262 $" class interface NETWORK_SOCKET_ADDRESS create make_from_hostname_and_port (a_hostname: STRING_8; a_port: INTEGER_32) require non_void_hostname: a_hostname /= Void valid_port: a_port >= 0 and then a_port <= 65535 ensure socket_address /= Void make_from_address_and_port (an_address: INET_ADDRESS; a_port: INTEGER_32) require valid_address: an_address /= Void valid_port: a_port >= 0 and then a_port <= 65535 ensure socket_address /= Void make_any_local (a_port: INTEGER_32) ensure socket_address /= Void make_localhost (a_port: INTEGER_32) make_loopback (a_port: INTEGER_32) make_from_separate (other: separate NETWORK_SOCKET_ADDRESS) -- Initialize from other. -- (from SOCKET_ADDRESS) ensure -- from SOCKET_ADDRESS equal: Current ~ other feature -- Initialization make_any_local (a_port: INTEGER_32) ensure socket_address /= Void make_from_address_and_port (an_address: INET_ADDRESS; a_port: INTEGER_32) require valid_address: an_address /= Void valid_port: a_port >= 0 and then a_port <= 65535 ensure socket_address /= Void make_from_hostname_and_port (a_hostname: STRING_8; a_port: INTEGER_32) require non_void_hostname: a_hostname /= Void valid_port: a_port >= 0 and then a_port <= 65535 ensure socket_address /= Void make_localhost (a_port: INTEGER_32) make_loopback (a_port: INTEGER_32) feature -- Access generating_type: TYPE [detachable NETWORK_SOCKET_ADDRESS] -- 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 frozen is_ipv4_stack_preferred: BOOLEAN -- (from INET_PROPERTIES) frozen is_ipv6_available: BOOLEAN -- (from INET_PROPERTIES) frozen set_ipv4_stack_preferred (preference: BOOLEAN) -- (from INET_PROPERTIES) socket_address: MANAGED_POINTER -- Hold data. -- (from SOCKET_ADDRESS) feature -- Measurement count: INTEGER_32 -- Size of address -- (from SOCKET_ADDRESS) 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: NETWORK_SOCKET_ADDRESS): 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: NETWORK_SOCKET_ADDRESS): BOOLEAN -- Is current address equal to other? -- (from SOCKET_ADDRESS) 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: NETWORK_SOCKET_ADDRESS): 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 address_in_use: BOOLEAN -- Address is in use by another socket. -- (from SOCKET_RESOURCES) address_not_readable: BOOLEAN -- Unreadable address -- (from SOCKET_RESOURCES) already_bound: BOOLEAN -- Socket has already been bound. -- (from SOCKET_RESOURCES) bad_socket_handle: BOOLEAN -- Socket descriptor is bad. -- (from SOCKET_RESOURCES) 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 connect_in_progress: BOOLEAN -- Call to connect returned on a non-blocking socket. -- (from SOCKET_RESOURCES) connection_refused: BOOLEAN -- Connection is refused (possibly due to security). -- (from SOCKET_RESOURCES) dtable_full: BOOLEAN -- Descriptor table is full -- (from SOCKET_RESOURCES) error: STRING_8 -- Output a related error message. -- (from SOCKET_RESOURCES) error_number: INTEGER_32 -- Returned error number -- (from SOCKET_RESOURCES) expired_socket: BOOLEAN -- Socket connection has expired. -- (from SOCKET_RESOURCES) family: INTEGER_32 -- Get the socket family of socket address. -- (from SOCKET_ADDRESS) host_address: INET_ADDRESS -- Host address of address invalid_address: BOOLEAN -- Address is not valid. -- (from SOCKET_RESOURCES) invalid_socket_handle: BOOLEAN -- Socket descriptor is not valid. -- (from SOCKET_RESOURCES) network: BOOLEAN -- Socket failed due to network problems. -- (from SOCKET_RESOURCES) no_buffers: BOOLEAN -- No more buffers available -- (from SOCKET_RESOURCES) no_permission: BOOLEAN -- No permission is given to user for this socket. -- (from SOCKET_RESOURCES) not_connected: BOOLEAN -- Socket is not connect. -- (from SOCKET_RESOURCES) port: INTEGER_32 -- Port number protected_address: BOOLEAN -- No access to this address is allowed. -- (from SOCKET_RESOURCES) protocol_not_supported: BOOLEAN -- Protocol is not supported on this platform. -- (from SOCKET_RESOURCES) 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)) socket_family_not_supported: BOOLEAN -- Requested family is not supported. -- (from SOCKET_RESOURCES) socket_in_use: BOOLEAN -- Socket is already in use. -- (from SOCKET_RESOURCES) socket_ok: BOOLEAN -- No error -- (from SOCKET_RESOURCES) socket_would_block: BOOLEAN -- Call to read, write, etc would have blocked. -- (from SOCKET_RESOURCES) zero_option: BOOLEAN -- No options provided -- (from SOCKET_RESOURCES) feature -- Status setting set_family (f: INTEGER_32) -- Set socket address family to f. -- (from SOCKET_ADDRESS) set_host_address (a_host_address: INET_ADDRESS) -- Set host address to a_host_address set_port (p: INTEGER_32) -- Set port to p. set_port_from_name (a_name, protocol: STRING_8) -- Set port number using a_name and protocol -- to refer into the (local) services file. feature -- Duplication copy (other: NETWORK_SOCKET_ADDRESS) -- Reinitialize by copying characters of other. -- (This is also used by `clone`.) -- (from SOCKET_ADDRESS) require -- from ANY other_not_void: other /= Void type_identity: same_type (other) ensure -- from ANY is_equal: Current ~ other ensure then -- from SOCKET_ADDRESS new_result_count: count = other.count or else count = address_size frozen deep_copy (other: NETWORK_SOCKET_ADDRESS) -- 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: NETWORK_SOCKET_ADDRESS -- 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: NETWORK_SOCKET_ADDRESS) -- 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: NETWORK_SOCKET_ADDRESS -- 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: NETWORK_SOCKET_ADDRESS -- 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 NETWORK_SOCKET_ADDRESS -- 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 create_any_local: INET_ADDRESS -- Address that allows connection from any host. -- (from INET_ADDRESS_FACTORY) ensure -- from INET_ADDRESS_FACTORY create_any_local_attached: Result /= Void create_from_address (address: ARRAY [NATURAL_8]): detachable INET_ADDRESS -- (from INET_ADDRESS_FACTORY) require -- from INET_ADDRESS_FACTORY valid_address: address /= Void create_from_name (hostname: READABLE_STRING_8): detachable INET_ADDRESS -- (from INET_ADDRESS_FACTORY) create_from_sockaddr (sockaddr: POINTER): detachable INET_ADDRESS -- (from INET_ADDRESS_FACTORY) require -- from INET_ADDRESS_FACTORY valid_sockaddr: sockaddr /= default_pointer create_localhost: INET_ADDRESS -- (from INET_ADDRESS_FACTORY) create_loopback: INET_ADDRESS -- Loopback address. -- (from INET_ADDRESS_FACTORY) ensure -- from INET_ADDRESS_FACTORY create_any_localhost_attached: Result /= Void feature -- is_valid_host (hostname: STRING_8): BOOLEAN require hostname_not_void: hostname /= Void feature -- Externals: flags for send, sendto recv and recvfrom socket calls c_msgdontroute: INTEGER_32 -- Do not route message -- (from SOCKET_RESOURCES) c_oobmsg: INTEGER_32 -- Out of bound message -- (from SOCKET_RESOURCES) c_peekmsg: INTEGER_32 -- Peek message -- (from SOCKET_RESOURCES) feature -- Initalization socket_address_make -- Make space available for address size. -- (from SOCKET_ADDRESS) 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 invariant -- from INET_PROPERTIES exclusive: is_ipv4_stack_preferred implies not is_ipv6_available -- from ANY reflexive_equality: standard_is_equal (Current) reflexive_conformance: conforms_to (Current) note copyright: "Copyright (c) 1984-2020, 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 NETWORK_SOCKET_ADDRESS -- Generated by Eiffel Studio --
For more details: eiffel.org