SerialPort.ReadTimeout Vlastnost

Definice

Obor názvů:

System.IO.Ports

Sestavení:

System.IO.Ports.dll

Balíček:

System.IO.Ports v11.0.0-preview.2.26159.112

Zdroj:

SerialPort.cs

Získá nebo nastaví počet milisekund před vypršením časového limitu, když operace čtení nedokončí.

public:
 property int ReadTimeout { int get(); void set(int value); };

public int ReadTimeout { get; set; }

member this.ReadTimeout : int with get, set

Public Property ReadTimeout As Integer

Hodnota vlastnosti

Int32

Počet milisekund před vypršením časového limitu nastane, když operace čtení nedokončí.

Výjimky

IOException

Port je v neplatném stavu.

nebo

Pokus o nastavení stavu základního portu se nezdařil. Například parametry předané z tohoto SerialPort objektu byly neplatné.

ArgumentOutOfRangeException

Hodnota časového limitu čtení je menší než nula a nerovná se InfiniteTimeout.

Příklady

Následující příklad kódu ukazuje použití SerialPort třídy, která umožňuje dvěma uživatelům chatovat ze dvou samostatných počítačů připojených kabelem modemu s hodnotou null. V tomto příkladu se uživatelům před chatováním zobrazí výzva k zadání nastavení portu a uživatelského jména. Tento příklad kódu je součástí většího příkladu kódu poskytnutého SerialPort pro třídu.

public static void Main()
{
    string name;
    string message;
    StringComparer stringComparer = StringComparer.OrdinalIgnoreCase;
    Thread readThread = new Thread(Read);

    // Create a new SerialPort object with default settings.
    _serialPort = new SerialPort();

    // Allow the user to set the appropriate properties.
    _serialPort.PortName = SetPortName(_serialPort.PortName);
    _serialPort.BaudRate = SetPortBaudRate(_serialPort.BaudRate);
    _serialPort.Parity = SetPortParity(_serialPort.Parity);
    _serialPort.DataBits = SetPortDataBits(_serialPort.DataBits);
    _serialPort.StopBits = SetPortStopBits(_serialPort.StopBits);
    _serialPort.Handshake = SetPortHandshake(_serialPort.Handshake);

    // Set the read/write timeouts
    _serialPort.ReadTimeout = 500;
    _serialPort.WriteTimeout = 500;

    _serialPort.Open();
    _continue = true;
    readThread.Start();

    Console.Write("Name: ");
    name = Console.ReadLine();

    Console.WriteLine("Type QUIT to exit");

    while (_continue)
    {
        message = Console.ReadLine();

        if (stringComparer.Equals("quit", message))
        {
            _continue = false;
        }
        else
        {
            _serialPort.WriteLine(
                String.Format("<{0}>: {1}", name, message));
        }
    }

    readThread.Join();
    _serialPort.Close();
}

public static void Read()
{
    while (_continue)
    {
        try
        {
            string message = _serialPort.ReadLine();
            Console.WriteLine(message);
        }
        catch (TimeoutException) { }
    }
}

Public Shared Sub Main()
    Dim name As String
    Dim message As String
    Dim stringComparer__1 As StringComparer = StringComparer.OrdinalIgnoreCase
    Dim readThread As New Thread(AddressOf Read)

    ' Create a new SerialPort object with default settings.
    _serialPort = New SerialPort()

    ' Allow the user to set the appropriate properties.
    _serialPort.PortName = SetPortName(_serialPort.PortName)
    _serialPort.BaudRate = SetPortBaudRate(_serialPort.BaudRate)
    _serialPort.Parity = SetPortParity(_serialPort.Parity)
    _serialPort.DataBits = SetPortDataBits(_serialPort.DataBits)
    _serialPort.StopBits = SetPortStopBits(_serialPort.StopBits)
    _serialPort.Handshake = SetPortHandshake(_serialPort.Handshake)

    ' Set the read/write timeouts
    _serialPort.ReadTimeout = 500
    _serialPort.WriteTimeout = 500

    _serialPort.Open()
    _continue = True
    readThread.Start()

    Console.Write("Name: ")
    name = Console.ReadLine()

    Console.WriteLine("Type QUIT to exit")

    While _continue
        message = Console.ReadLine()

        If stringComparer__1.Equals("quit", message) Then
            _continue = False
        Else
            _serialPort.WriteLine([String].Format("<{0}>: {1}", name, message))
        End If
    End While

    readThread.Join()
    _serialPort.Close()
End Sub

Public Shared Sub Read()
    While _continue
        Try
            Dim message As String = _serialPort.ReadLine()
            Console.WriteLine(message)
        Catch generatedExceptionName As TimeoutException
        End Try
    End While
End Sub

Poznámky

Hodnota časového limitu čtení byla původně nastavena na 500 milisekund v rozhraní WIN32 Communications API. Tato vlastnost umožňuje nastavit tuto hodnotu. Časový limit lze nastavit na libovolnou hodnotu větší než nula nebo nastavit na InfiniteTimeouthodnotu , v takovém případě nedojde k vypršení časového limitu. InfiniteTimeout je výchozí.

Poznámka:

Uživatelé nespravované COMMTIMEOUTS struktury mohou očekávat, že nastaví hodnotu časového limitu na nulu, aby potlačí vypršení časového limitu. Chcete-li potlačit časový limit vlastnosti ReadTimeout , je však nutné zadat InfiniteTimeout.

Tato vlastnost nemá vliv na BeginRead metodu datového proudu vráceného BaseStream vlastností.