HardwareStream

SearchWithTimeout

Attributes

BitRate DefaultTimeout MaxBitRate MaxReadRate MaxWriteRate ReadRate State WriteRate

Fields

Define Class HardwareStream;
    abstract;
    inherits from Server;
    inherits from Stream;

    field state: Unsigned, getter, setter;
        // current hardware state representation
    field readRate: Unsigned, getter, setter;
    field writeRate: Unsigned, getter, setter;
    field maxReadRate: Unsigned, getter, setter;
    field maxWriteRate: Unsigned, getter, setter;
    field defaultTimeout: Unsigned, getter, setter;
        // Timeout value (in ms) to use on Read() and Write()
        // Timeout defaults to 0 (no timeout, wait forever)

    // These operations override the default Timeout value for one call
    // They will block and call RunNext until data is ready or timeout has expired
    operation SearchWithTimeout(pattern: ReadOnlyPointer; count: Unsigned; timeout: Unsigned): Boolean;

    // Parameter query - Rates in bps (bits/sec).
    attribute BitRate: Unsigned;
        // Return current i/o bit rate, lower if mismatched
    attribute MaxBitRate: Unsigned;
        // Return maximum i/o rate
    attribute ReadRate: Unsigned;
    attribute WriteRate: Unsigned;
    attribute MaxReadRate: Unsigned;
    attribute MaxWriteRate: Unsigned;
    attribute State: Unsigned;
    attribute DefaultTimeout: Unsigned;
end class;