SECOM
Overview Cluster Class Classes Index          Top Features

secom.windows

Class COM_STATUS


Direct ancestors

EWG_STRUCT, KL_SHARED_EXCEPTIONS, COM_ERROR_CONSTANTS, COM_SHARED_WINDOWS_ERROR

Creation

Features

Invariants

indexing

description

Objects that retrieve the status of a communications device.

library

Serial Communications Library

copyright

Copyright (c) 2005, Brian E. Heilig

license

Eiffel Forum License v2 (see license.txt)

class COM_STATUS

inherit

EWG_STRUCT

create

make

-- Create an uninitialized com status structure.

ensure

exists: exists
not_shared: not is_shared

make_existing (comm: COM_DEVICE)

-- Create this structure from an extant, open communications device.
-- Throws an exception if call to get_comm_stat fails.

require

exists: comm /= Void
handle_available: comm.is_open

ensure

exists: exists
not_shared: not is_shared

feature -- Access

in_queue_count: INTEGER

-- Number of bytes received by the serial provider but not yet read.

last_error: INTEGER

-- Last error reported from get_comm_stat.

out_queue_count: INTEGER

-- Number of bytes remaining to be transmitted for all write operations.

feature -- Status report

is_cts_hold: BOOLEAN

-- Is transmission waiting for the CTS (clear-to-send) signal to be sent?

is_dsr_hold: BOOLEAN

-- Is transmission waiting for the DSR (data-set-ready) signal to be sent?

is_eof: BOOLEAN

-- Has the EOF (end-of-file) character been received?

is_rlsd_hold: BOOLEAN

-- Is transmission waiting for the RLSD (receive-line-signal-detect)
-- signal to be sent?

is_tx_char_queued: BOOLEAN

-- Is there a character queued for transmission that has come to the
-- communications device by way of the transmit_comm_char function?
-- The communications device transmits such a character ahead of other
-- characters in the device's output buffer.

is_xoff_hold: BOOLEAN

-- Is transmission waiting because the XOFF character was received?

is_xoff_sent: BOOLEAN

-- Is transmission waiting because the XOFF character was transmitted?

feature -- Element change

get_comm_stat (comm: COM_DEVICE)

-- Retrieve the current information about the comm device.
-- This function has the unavoidable side effect of clearing any
-- comm error. Throws an exception if call fails.

require

exists: comm /= Void
handle_available: comm.is_open

invariant


Documentation generated by edoc