indexing
description: "Data resources"
legal: "See notice at end of class."
status: "See notice at end of class."
date: "$Date: 2006-01-22 18:25:44 -0800 (Sun, 22 Jan 2006) $"
revision: "$Revision: 56675 $"
deferred class interface
DATA_RESOURCE
feature
address: URL
generating_type: STRING_8
ANY
generator: STRING_8
ANY
hash_code: INTEGER_32
ensure HASHABLE
good_hash_value: Result >= 0
last_packet: STRING_8
location: STRING_8
require
address_exists: address /= Void
mode: INTEGER_32
port: INTEGER_32
ensure
result_non_negative: Result >= 0
proxy_host: STRING_8
require
proxy_supported: is_proxy_supported
proxy_used: is_proxy_used
ensure
result_not_empty: Result /= Void and then not Result.is_empty
proxy_port: INTEGER_32
require
proxy_supported: is_proxy_supported
proxy_used: is_proxy_used
ensure
result_non_negative: Result >= 0
service: STRING_8
feature
bytes_transferred: INTEGER_32
count: INTEGER_32
last_packet_size: INTEGER_32
read_buffer_size: INTEGER_32
feature
frozen deep_equal (some: ANY; other: like arg #1): BOOLEAN
`some'`other'
ANY
ensure ANY
shallow_implies_deep: standard_equal (some, other) implies Result
both_or_none_void: (some = Void) implies (Result = (other = Void))
same_type: (Result and (some /= Void)) implies some.same_type (other)
symmetric: Result implies deep_equal (other, some)
frozen equal (some: ANY; other: like arg #1): BOOLEAN
`some'`other'
ANY
ensure ANY
definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.is_equal (other))
is_equal (other: like Current): BOOLEAN
`other'
require ANY
other_not_void: other /= Void
ensure ANY
symmetric: Result implies other.is_equal (Current)
consistent: standard_is_equal (other) implies Result
frozen standard_equal (some: ANY; other: like arg #1): BOOLEAN
`some'`other'
ANY
ensure ANY
definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.standard_is_equal (other))
frozen standard_is_equal (other: like Current): BOOLEAN
`other'
ANY
require ANY
other_not_void: other /= Void
ensure ANY
same_type: Result implies same_type (other)
symmetric: Result implies other.standard_is_equal (Current)
feature
address_exists: BOOLEAN
conforms_to (other: ANY): BOOLEAN
`other'
ANY
require ANY
other_not_void: other /= Void
error: BOOLEAN
error_code: INTEGER_32
error_text (code: INTEGER_32): STRING_8
DATA_RESOURCE_ERROR_CONSTANTS
require DATA_RESOURCE_ERROR_CONSTANTS
positive_code: code > 0
has_packet: BOOLEAN
last_packet
is_count_valid: BOOLEAN
count
is_hashable: BOOLEAN
ensure HASHABLE
ok_if_not_default: Result implies (Current /= default)
is_mode_set: BOOLEAN
is_open: BOOLEAN
is_packet_pending: BOOLEAN
is_proxy_supported: BOOLEAN
is_proxy_used: BOOLEAN
is_readable: BOOLEAN
ensure
mode_unchanged: mode = old mode
is_writable: BOOLEAN
ensure
mode_unchanged: mode = old mode
read_mode: BOOLEAN
same_type (other: ANY): BOOLEAN
`other'
ANY
require ANY
other_not_void: other /= Void
ensure ANY
definition: Result = (conforms_to (other) and other.conforms_to (Current))
supports_multiple_transactions: BOOLEAN
timeout: INTEGER_32
transfer_initiated: BOOLEAN
valid_mode (n: INTEGER_32): BOOLEAN
`n'
write_mode: BOOLEAN
feature
close
require
open: is_open
ensure
closed: not is_open
mode_unchanged: mode = old mode
no_packet_available: not (has_packet and is_packet_pending)
initiate_transfer
require
no_error_occurred: not error
mode_set: is_mode_set
open: is_open
not_initiated: not transfer_initiated
ensure
failure_means_error: not transfer_initiated implies error
open
require
no_error_occurred: not error
mode_set: is_mode_set
ensure
no_packet_available: not (has_packet and is_packet_pending)
initiated_flag_reset: not transfer_initiated
failure_means_error: not is_open implies error
reset_error
ensure
error_reset: not error
reset_proxy
ensure
proxy_reset: not address.is_proxy_used
reuse_connection (other: DATA_RESOURCE)
`other'
require
other_exists: other /= Void
same_type: same_type (other)
supports_multiple_transactions: supports_multiple_transactions and other.supports_multiple_transactions
other_opened: other.is_open
set_password (pw: STRING_8)
`pw'
require
password_accepted: address.is_password_accepted
non_empty_password: pw /= Void and then not pw.is_empty
set_port (port_no: INTEGER_32)
`port_no'
require
closed: not is_open
non_negative_port_number: port_no >= 0
ensure
port_set: port = port_no
set_proxy (host: STRING_8; port_no: INTEGER_32)
`host'`port_no'
require
proxy_supported: is_proxy_supported
closed: not is_open
non_empty_host: host /= Void and then not host.is_empty
host_ok: address.proxy_host_ok (host)
non_negative_port: port_no >= 0
ensure
proxy_set: address.is_proxy_used
set_proxy_information (pi: PROXY_INFORMATION)
`pi'
require
proxy_supported: is_proxy_supported
ensure
proxy_set: address.is_proxy_used
set_read_buffer_size (n: INTEGER_32)
require
size_positive: n > 0
ensure
buffer_size_set: read_buffer_size = n
set_read_mode
ensure
read_mode_set: read_mode
set_timeout (n: INTEGER_32)
`n'
require
non_negative: n >= 0
ensure
timeout_set: timeout = n
set_username (un: STRING_8)
`un'
require
username_accepted: address.has_username
non_empty_username: un /= Void and then not un.is_empty
set_write_mode
ensure
write_mode_set: write_mode
feature
dispose
feature
copy (other: like Current)
`other'
ANY
require ANY
other_not_void: other /= Void
type_identity: same_type (other)
ensure ANY
is_equal: is_equal (other)
frozen deep_copy (other: like Current)
copy`other'deep_twin
ANY
require ANY
other_not_void: other /= Void
ensure ANY
deep_equal: deep_equal (Current, other)
frozen deep_twin: like Current
ANY
ensure ANY
deep_equal: deep_equal (Current, Result)
frozen standard_copy (other: like Current)
`other'
ANY
require ANY
other_not_void: other /= Void
type_identity: same_type (other)
ensure ANY
is_standard_equal: standard_is_equal (other)
frozen standard_twin: like Current
`other'
ANY
ensure ANY
standard_twin_not_void: Result /= Void
equal: standard_equal (Result, Current)
frozen twin: like Current
`Current'
twincopycopy
ANY
ensure ANY
twin_not_void: Result /= Void
is_equal: Result.is_equal (Current)
feature
frozen default: like Current
ANY
frozen default_pointer: POINTER
`POINTER'
`p'default
`p'`POINTER'
ANY
default_rescue
ANY
frozen do_nothing
ANY
feature
read
require
no_error_occurred: not error
open: is_open
transfer_initated: transfer_initiated
readable: is_readable
positive_read_buffer_size: read_buffer_size > 0
packet_pending: is_packet_pending
ensure
packet_received: is_packet_pending implies last_packet_size > 0
counter_correct: not error implies bytes_transferred = old bytes_transferred + last_packet_size
feature
io: STD_FILES
ANY
out: STRING_8
ANYtagged_out
ANY
print (some: ANY)
`some'
ANY
put (other: DATA_RESOURCE)
`other'
require
no_error_occurred: not (error and other.error)
other_resource_exists: other /= Void
resources_open: is_open and other.is_open
writable: is_writable
transfer_initated: transfer_initiated
frozen tagged_out: STRING_8
ANYout
ANY
feature
operating_environment: OPERATING_ENVIRONMENT
ANY
invariant
address_assigned: address /= Void
timeout_non_negative: timeout >= 0
packet_constraint: not (has_packet xor last_packet /= Void)
pending_constraint: is_packet_pending implies (is_open and is_readable and transfer_initiated)
error_definition: error = (error_code /= 0)
valid_count_constraint: count > 0 implies is_count_valid
mode_constraint: is_mode_set = read_mode xor write_mode
ANY
reflexive_equality: standard_is_equal (Current)
reflexive_conformance: conforms_to (Current)
indexing
copyright: "Copyright (c) 1984-2006, Eiffel Software and others"
license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
source: "[
Eiffel Software
356 Storke Road, Goleta, CA 93117 USA
Telephone 805-685-1006, Fax 805-685-6869
Website http://www.eiffel.com
Customer support http://support.eiffel.com
]"
end DATA_RESOURCE