SECOM
Overview Cluster Class Classes Index          Top Features

secom.windows

Class COM_PROPERTIES


Direct ancestors

EWG_STRUCT, KL_SHARED_EXCEPTIONS, COM_SHARED_WINDOWS_ERROR

Creation

Features

Invariants

indexing

description

Information about a given communications driver.

library

Serial Communications Library

copyright

Copyright (c) 2005, Brian E. Heilig

license

Eiffel Forum License v2 (see license.txt)

class COM_PROPERTIES

inherit

EWG_STRUCT

create

make

-- Create an uninitialized comm properties 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 GetCommProperties fails.

require

exists: comm /= Void
handle_available: comm.is_open

ensure

exists: exists
not_shared: not is_shared

feature -- Access

current_rx_queue: INTEGER

-- Size of the driver's internal input buffer, in bytes.
-- A value of zero indicates that the value is unavailable.

current_tx_queue: INTEGER

-- Size of the driver's internal output buffer, in bytes.
-- A value of zero indicates that the value is unavailable.

max_baud: INTEGER

-- Maximum allowable baud rate. See selectable baud rates in COM_PROP_CONSTANTS
-- for possible values.

max_rx_queue: INTEGER

-- Maximum size of the driver's internal input buffer, in bytes. A value of
-- zero indicates that no maximum value is imposed by the serial provider.

max_tx_queue: INTEGER

-- Maximum size of the driver's internal output buffer, in bytes. A value
-- of zero indicates that no maximum value is imposed by the serial provider.

packet_length: INTEGER_16

-- Size of the entire data packet, regardless of the amount
-- of data requested, in bytes.

packet_version: INTEGER_16

-- Version of the structure.

provider_capabilities: INTEGER

-- Capabilities offered by the provider. See provider capabilities in
-- COM_PROP_CONSTANTS for possible values.

provider_specific1: INTEGER

-- Provider-specific data. Clients should ignore this member
-- unless they have detailed information about the format of
-- the data required by the provider.

provider_specific2: INTEGER

-- Provider-specific data. Clients should ignore this member
-- unless they have detailed information about the format of
-- the data required by the provider.

provider_sub_type: INTEGER

-- Communications-provider type. See provider sub types in COM_PROP_CONSTANTS
-- for possible values.

service_mask: INTEGER

-- Bitmask indicating which services are implemented by this provider.
-- Sp_serial_comm is always specified for communications providers,
-- including modem providers.

settable_baud: INTEGER

-- A bit mask of baud rates that can be used. See selectable baud rates in
-- COM_PROP_CONSTANTS for possible values.

settable_data: INTEGER_16

-- Bit mask of possible settings for data word size. See selectable data bits in
-- COM_PROP_CONSTANTS for possible values.

settable_params: INTEGER

-- Communications parameters that can be changed. See settable parameters in
-- COM_PROP_CONSTANTS for possible values.

settable_stop_and_parity: INTEGER_16

-- Stop bit and parity settings that can be selected. See selectable stop bits and
-- selectable parity scheme in COM_PROP_CONSTANTS for possible values.

feature -- Element change

get_comm_properties (comm: COM_DEVICE)

-- Fill this structure with comms most recent properties.
-- Throws an exception if call to get comm properties fails.

require

exists: comm /= Void
handle_available: comm.is_open

invariant


Documentation generated by edoc