Serial Communications Library
Copyright (c) 2005, Brian E. Heilig
Eiffel Forum License v2 (see license.txt)
-- Create an uninitialized com timeouts structure.
-- Create this structure from an extant, open communications device.
-- Throws an exception if GetCommTimeouts fails.
-- Maximum time allowed to elapse between the arrival of two
-- characters on the communications line, in milliseconds.
-- During a read operation, the time period begins when the
-- first character is received. If the interval between the
-- arrival of any two characters exceeds this amount, the
-- read operation is completed and any buffered data is returned.
-- A value of zero indicates that interval time-outs are not used.
-- A value of -1, combined with zero values for both the
-- read_total_constant and read_total_multiplier specifies
-- that the read operation is to return immediately with the
-- characters that have already been received, even if no
-- characters have been received.
-- Constant used to calculate the total time-out period for read
-- operations, in milliseconds. For each read operation, this value
-- is added to the product of read_total_multiplier and the
-- requested number of bytes.
-- A value of zero for both read_total_multiplier and this
-- indicates that total time-outs are not used for read operations.
-- Multiplier used to calculate the total time-out period for read
-- operations, in milliseconds. For each read operation, this value
-- is multiplied by the requested number of bytes to be read.
-- Constant used to calculate the total time-out period for write
-- operations, in milliseconds. For each write operation, this value
-- is added to the product of write_total_multiplier member and
-- the number of bytes to be written.
-- A value of zero for both the write_total_multiplier and this
-- indicates that total time-outs are not used for write operations.
-- Multiplier used to calculate the total time-out period for write
-- operations, in milliseconds. For each write operation, this value
-- is multiplied by the number of bytes to be written.
-- Indicates read operations block until the requested
-- number of bytes have been read.
-- Indicates read operations return immediately with the number of
-- bytes already received, even if no bytes have been received?
-- Fill this structure with the timeout properties of an extant,
-- open communications device. Throw an exception if call to
-- GetCommTimeouts fails.
-- Set the timeout properties to be a pure blocking read.
-- Set the timeout properties to include an inter-character
-- timer.
-- Set the timeout properties to be a non-blocking read.
-- Set the timeout properties to include an overall timer.
Objects that set and query the timeout properties of a communications device.