commbase.xml

微软C#读写类

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>CommBase</name>
    </assembly>
    <members>
        <member name="T:JH.CommBase.CommBase">
            <summary>
            Lowest level Com driver handling all Win32 API calls and processing send and receive in terms of
            individual bytes. Used as a base class for higher level drivers.
            </summary>
        </member>
        <member name="M:JH.CommBase.CommBase.Open">
            <summary>
            Opens the com port and configures it with the required settings
            </summary>
            <returns>false if the port could not be opened</returns>
        </member>
        <member name="M:JH.CommBase.CommBase.Close">
            <summary>
            Closes the com port.
            </summary>
        </member>
        <member name="M:JH.CommBase.CommBase.Dispose">
            <summary>
            For IDisposable
            </summary>
        </member>
        <member name="M:JH.CommBase.CommBase.Finalize">
            <summary>
            Destructor (just in case)
            </summary>
        </member>
        <member name="M:JH.CommBase.CommBase.Flush">
            <summary>
            Block until all bytes in the queue have been transmitted.
            </summary>
        </member>
        <member name="M:JH.CommBase.CommBase.ThrowException(System.String)">
            <summary>
            Use this to throw exceptions in derived classes. Correctly handles threading issues
            and closes the port if necessary.
            </summary>
            <param name="reason">Description of fault</param>
        </member>
        <member name="M:JH.CommBase.CommBase.Send(System.Byte[])">
            <summary>
            Queues bytes for transmission. 
            </summary>
            <param name="tosend">Array of bytes to be sent</param>
        </member>
        <member name="M:JH.CommBase.CommBase.Send(System.Byte)">
            <summary>
            Queues a single byte for transmission.
            </summary>
            <param name="tosend">Byte to be sent</param>
        </member>
        <member name="M:JH.CommBase.CommBase.SendImmediate(System.Byte)">
            <summary>
            Sends a protocol byte immediately ahead of any queued bytes.
            </summary>
            <param name="tosend">Byte to send</param>
            <returns>False if an immediate byte is already scheduled and not yet sent</returns>
        </member>
        <member name="M:JH.CommBase.CommBase.Sleep(System.Int32)">
            <summary>
            Delay processing.
            </summary>
            <param name="milliseconds">Milliseconds to delay by</param>
        </member>
        <member name="M:JH.CommBase.CommBase.GetModemStatus">
            <summary>
            Gets the status of the modem control input signals.
            </summary>
            <returns>Modem status object</returns>
        </member>
        <member name="M:JH.CommBase.CommBase.GetQueueStatus">
            <summary>
            Get the status of the queues
            </summary>
            <returns>Queue status object</returns>
        </member>
        <member name="M:JH.CommBase.CommBase.CommSettings">
            <summary>
            Override this to provide settings. (NB this is called during Open method)
            </summary>
            <returns>CommBaseSettings, or derived object with required settings initialised</returns>
        </member>
        <member name="M:JH.CommBase.CommBase.AfterOpen">
            <summary>
            Override this to provide processing after the port is openned (i.e. to configure remote
            device or just check presence).
            </summary>
            <returns>false to close the port again</returns>
        </member>
        <member name="M:JH.CommBase.CommBase.BeforeClose(System.Boolean)">
            <summary>
            Override this to provide processing prior to port closure.
            </summary>
            <param name="error">True if closing due to an error</param>
        </member>
        <member name="M:JH.CommBase.CommBase.OnRxChar(System.Byte)">
            <summary>
            Override this to process received bytes.
            </summary>
            <param name="ch">The byte that was received</param>
        </member>
        <member name="M:JH.CommBase.CommBase.OnTxDone">
            <summary>
            Override this to take action when transmission is complete (i.e. all bytes have actually
            been sent, not just queued).
            </summary>
        </member>
        <member name="M:JH.CommBase.CommBase.OnBreak">
            <summary>
            Override this to take action when a break condition is detected on the input line.
            </summary>
        </member>
        <member name="M:JH.CommBase.CommBase.OnRing">
            <summary>
            Override this to take action when a ring condition is signalled by an attached modem.
            </summary>
        </member>
        <member name="M:JH.CommBase.CommBase.OnStatusChange(JH.CommBase.CommBase.ModemStatus,JH.CommBase.CommBase.ModemStatus)">
            <summary>
            Override this to take action when one or more modem status inputs change state
            </summary>
            <param name="mask">The status inputs that have changed state</param>
            <param name="state">The state of the status inputs</param>
        </member>
        <member name="M:JH.CommBase.CommBase.OnRxException(System.Exception)">
            <summary>
            Override this to take action when the reception thread closes due to an exception being thrown.
            </summary>
            <param name="e">The exception which was thrown</param>
        </member>
        <member name="P:JH.CommBase.CommBase.Online">
            <summary>
            True if online.
            </summary>
        </member>
        <member name="P:JH.CommBase.CommBase.RTSavailable">
            <summary>
            True if the RTS pin is controllable via the RTS property
            </summary>
        </member>
        <member name="P:JH.CommBase.CommBase.RTS">
            <summary>
            Set the state of the RTS modem control output
            </summary>
        </member>
        <member name="P:JH.CommBase.CommBase.DTRavailable">
            <summary>
            True if the DTR pin is controllable via the DTR property
            </summary>
        </member>
        <member name="P:JH.CommBase.CommBase.DTR">
            <summary>
            The state of the DTR modem control output
            </summary>
        </member>
        <member name="P:JH.CommBase.CommBase.Break">
            <summary>
            Assert or remove a break condition from the transmission line
            </summary>
        </member>
        <member name="T:JH.CommBase.CommBase.Parity">
            <summary>
            Parity settings
            </summary>
        </member>
        <member name="F:JH.CommBase.CommBase.Parity.none">
            <summary>
            Characters do not have a parity bit.
            </summary>
        </member>
        <member name="F:JH.CommBase.CommBase.Parity.odd">
            <summary>
            If there are an odd number of 1s in the data bits, the parity bit is 1.
            </summary>
        </member>
        <member name="F:JH.CommBase.CommBase.Parity.even">
            <summary>
            If there are an even number of 1s in the data bits, the parity bit is 1.
            </summary>
        </member>
        <member name="F:JH.CommBase.CommBase.Parity.mark">
            <summary>
            The parity bit is always 1.
            </summary>
        </member>
        <member name="F:JH.CommBase.CommBase.Parity.space">
            <summary>
            The parity bit is always 0.
            </summary>
        </member>
        <member name="T:JH.CommBase.CommBase.StopBits">
            <summary>
            Stop bit settings
            </summary>
        </member>
        <member name="F:JH.CommBase.CommBase.StopBits.one">
            <summary>
            Line is asserted for 1 bit duration at end of each character
            </summary>
        </member>
        <member name="F:JH.CommBase.CommBase.StopBits.onePointFive">
            <summary>
            Line is asserted for 1.5 bit duration at end of each character
            </summary>
        </member>
        <member name="F:JH.CommBase.CommBase.StopBits.two">
            <summary>
            Line is asserted for 2 bit duration at end of each character
            </summary>
        </member>
        <member name="T:JH.CommBase.CommBase.HSOutput">
            <summary>
            Uses for RTS or DTR pins
            </summary>
        </member>
        <member name="F:JH.CommBase.CommBase.HSOutput.handshake">
            <summary>
            Pin is asserted when this station is able to receive data.
            </summary>
        </member>
        <member name="F:JH.CommBase.CommBase.HSOutput.gate">
            <summary>
            Pin is asserted when this station is transmitting data (RTS on NT, 2000 or XP only).
            </summary>
        </member>
        <member name="F:JH.CommBase.CommBase.HSOutput.online">
            <summary>
            Pin is asserted when this station is online (port is open).
            </summary>
        </member>
        <member name="F:JH.CommBase.CommBase.HSOutput.none">
            <summary>
            Pin is never asserted.
            </summary>
        </member>
        <member name="T:JH.CommBase.CommBase.Handshake">
            <summary>
            Standard handshake methods
            </summary>
        </member>
        <member name="F:JH.CommBase.CommBase.Handshake.none">
            <summary>
            No handshaking
            </summary>
        </member>
        <member name="F:JH.CommBase.CommBase.Handshake.XonXoff">
            <summary>
            Software handshaking using Xon / Xoff
            </summary>
        </member>
        <member name="F:JH.CommBase.CommBase.Handshake.CtsRts">
            <summary>
            Hardware handshaking using CTS / RTS
            </summary>
        </member>
        <member name="F:JH.CommBase.CommBase.Handshake.DsrDtr">
            <summary>
            Hardware handshaking using DSR / DTR
            </summary>
        </member>
        <member name="T:JH.CommBase.CommBase.CommBaseSettings">
            <summary>
            Set the public fields to supply settings to CommBase.
            </summary>
        </member>
        <member name="F:JH.CommBase.CommBase.CommBaseSettings.port">
            <summary>
            Port Name (default: "COM1:")
            </summary>
        </member>
        <member name="F:JH.CommBase.CommBase.CommBaseSettings.baudRate">
            <summary>
            Baud Rate (default: 2400) unsupported rates will throw "Bad settings"
            </summary>
        </member>
        <member name="F:JH.CommBase.CommBase.CommBaseSettings.parity">
            <summary>
            The parity checking scheme (default: none)
            </summary>
        </member>
        <member name="F:JH.CommBase.CommBase.CommBaseSettings.dataBits">
            <summary>
            Number of databits 1..8 (default: 8) unsupported values will throw "Bad settings"
            </summary>
        </member>
        <member name="F:JH.CommBase.CommBase.CommBaseSettings.stopBits">
            <summary>
            Number of stop bits (default: one)
            </summary>
        </member>
        <member name="F:JH.CommBase.CommBase.CommBaseSettings.txFlowCTS">
            <summary>
            If true, transmission is halted unless CTS is asserted by the remote station (default: false)
            </summary>
        </member>
        <member name="F:JH.CommBase.CommBase.CommBaseSettings.txFlowDSR">
            <summary>
            If true, transmission is halted unless DSR is asserted by the remote station (default: false)
            </summary>
        </member>
        <member name="F:JH.CommBase.CommBase.CommBaseSettings.txFlowX">
            <summary>
            If true, transmission is halted when Xoff is received and restarted when Xon is received (default: false)