RegexMatchTimeoutException Klasa

Definicja

Wyjątek, który jest generowany, gdy czas wykonywania metody dopasowywania do wzorca wyrażenia regularnego przekracza limit czasu.The exception that is thrown when the execution time of a regular expression pattern-matching method exceeds its time-out interval.

public ref class RegexMatchTimeoutException : TimeoutException
public class RegexMatchTimeoutException : TimeoutException
[System.Serializable]
public class RegexMatchTimeoutException : TimeoutException
type RegexMatchTimeoutException = class
    inherit TimeoutException
type RegexMatchTimeoutException = class
    inherit TimeoutException
    interface ISerializable
Public Class RegexMatchTimeoutException
Inherits TimeoutException
Dziedziczenie
RegexMatchTimeoutException
Dziedziczenie
RegexMatchTimeoutException
Atrybuty
Implementuje

Przykłady

Poniższy przykład ilustruje dwa możliwe podejścia do obsługi wyjątku RegexMatchTimeoutException.The following example illustrates two possible approaches to handling the RegexMatchTimeoutException exception. Stała o wartości 2 sekund określa maksymalny limit czasu.A constant whose value is two seconds defines the maximum time-out interval. Metoda Regex.IsMatch(String, String, RegexOptions, TimeSpan) jest początkowo wywoływana z interwałem limitu czasu wynoszącym jeden sekund.The Regex.IsMatch(String, String, RegexOptions, TimeSpan) method is initially called with a time-out interval of one second. Każdy wyjątek RegexMatchTimeoutException powoduje, że limit czasu, który ma zostać zwiększony o jeden sekund i skutkuje innym wywołaniem metody Regex.IsMatch, jeśli bieżący interwał limitu czasu jest mniejszy niż maksymalny limit czasu.Each RegexMatchTimeoutException exception causes the time-out interval to be increased by one second and results in another call to the Regex.IsMatch method if the current time-out interval is less than the maximum time-out interval. Jeśli jednak bieżący interwał limitu czasu przekracza maksymalny limit czasu, program obsługi wyjątków zapisuje informacje w dzienniku zdarzeń i porzuca przetwarzanie wyrażenia regularnego.However, if the current time-out interval exceeds the maximum time-out interval, the exception handler writes information to the event log and abandons the processing of the regular expression.

using System;
using System.ComponentModel;
using System.Diagnostics;
using System.Security;
using System.Text.RegularExpressions;
using System.Threading;

public class Example
{
   const int MaxTimeoutInSeconds = 2;
   
   public static void Main()
   {
      TimeSpan timeout = new TimeSpan(0, 0, 1);
      string input = "aaaaaaaaaaaaaaaaaaaaaa>";
      if (ValidateInput(input, timeout))
         // Perform some operation with valid input string.
         Console.WriteLine("'{0}' is a valid string.", input); 
   } 

   private static bool ValidateInput(string input, TimeSpan timeout)
   {
      string pattern = "(a+)+$";      
      try {
         return Regex.IsMatch(input, pattern, 
                              RegexOptions.IgnoreCase, timeout);
      }
      catch (RegexMatchTimeoutException e) {
         // Increase the timeout interval and retry.
         timeout = timeout.Add(new TimeSpan(0, 0, 1));
         Console.WriteLine("Changing the timeout interval to {0}", 
                           timeout); 
         if (timeout.TotalSeconds <= MaxTimeoutInSeconds) {
            // Pause for a short period.
            Thread.Sleep(250);
            return ValidateInput(input, timeout);
         }   
         else {
            Console.WriteLine("Timeout interval of {0} exceeded.", 
                              timeout);
            // Write to event log named RegexTimeouts
            try {
               if (! EventLog.SourceExists("RegexTimeouts"))
                  EventLog.CreateEventSource("RegexTimeouts", "RegexTimeouts");

               EventLog log = new EventLog("RegexTimeouts");
               log.Source = "RegexTimeouts";
               string msg = String.Format("Timeout after {0} matching '{1}' with '{2}.",
                                          e.MatchTimeout, e.Input, e.Pattern);
               log.WriteEntry(msg, EventLogEntryType.Error);
            }
            // Do nothing to handle the exceptions.
            catch (SecurityException) { }
            catch (InvalidOperationException) { }
            catch (Win32Exception) { }
            return false;
         }   
      }
   }
}
// The example writes to the event log and also displays the following output:
//       Changing the timeout interval to 00:00:02
//       Changing the timeout interval to 00:00:03
//       Timeout interval of 00:00:03 exceeded.
Imports System.ComponentModel
Imports System.Diagnostics
Imports System.Security
Imports System.Text.RegularExpressions
Imports System.Threading

Module Example
   Const MaxTimeoutInSeconds As Integer = 2
   
   Public Sub Main()
      Dim timeout As TimeSpan = New TimeSpan(0, 0, 1)
      
      Dim input As String = "aaaaaaaaaaaaaaaaaaaaaa>"
      If ValidateInput(input, timeout) Then
         ' Perform some operation with valid input string.
         Console.WriteLine("'{0}' is a valid string.", input) 
      End If
   End Sub 

   Private Function ValidateInput(input As String, 
                                  timeout As TimeSpan) As Boolean
      Dim pattern As String = "(a+)+$"      
      Try
         Return Regex.IsMatch(input, pattern, 
                              RegexOptions.IgnoreCase, timeout)
      Catch e As RegexMatchTimeoutException
         ' Increase the timeout interval and retry.
         timeout = timeout.Add(New TimeSpan(0, 0, 1))
         Console.WriteLine("Changing the timeout interval to {0}", 
                           timeout) 
         If timeout.TotalSeconds <= MaxTimeoutInSeconds Then
            ' Pause for a short interval.
            Thread.Sleep(250)
            Return ValidateInput(input, timeout)
         Else
            Console.WriteLine("Timeout interval of {0} exceeded.", 
                              timeout)
            ' Write to event log named RegexTimeouts
            Try
               If Not EventLog.SourceExists("RegexTimeouts") Then
                  EventLog.CreateEventSource("RegexTimeouts", "RegexTimeouts")
               End If   
               Dim log As New EventLog("RegexTimeouts")
               log.Source = "RegexTimeouts"
               Dim msg As String = String.Format("Timeout after {0} matching '{1}' with '{2}.",
                                                 e.MatchTimeout, e.Input, e.Pattern)
               log.WriteEntry(msg, EventLogEntryType.Error)
            ' Do nothing to handle the exceptions.
            Catch ex As SecurityException

            Catch ex As InvalidOperationException

            Catch ex As Win32Exception

            End Try   
            Return False
         End If   
      End Try
   End Function
End Module
' The example writes to the event log and also displays the following output:
'       Changing the timeout interval to 00:00:02
'       Changing the timeout interval to 00:00:03
'       Timeout interval of 00:00:03 exceeded.

Uwagi

Obecność RegexMatchTimeoutException wyjątek zwykle wskazuje jeden z następujących warunków:The presence of a RegexMatchTimeoutException exception generally indicates one of the following conditions:

  • Aparat wyrażeń regularnych jest nadmiernie śledzony, ponieważ próbuje dopasować tekst wejściowy do wzorca wyrażenia regularnego.The regular expression engine is backtracking excessively as it attempts to match the input text to the regular expression pattern.

  • Interwał limitu czasu został zbyt niski, szczególnie w przypadku dużego obciążenia maszynowego.The time-out interval has been set too low, especially given high machine load.

Sposób, w jaki program obsługi wyjątków obsługuje wyjątek, zależy od przyczyny wyjątku:The way in which an exception handler handles an exception depends on the cause of the exception:

  • Jeśli limit czasu wynika z nadmiernego wycofywania, program obsługi wyjątków powinien zrezygnować z próby dopasowania danych wejściowych i poinformować użytkownika o przekroczeniu limitu czasu w metodzie dopasowania wzorca wyrażenia regularnego.If the time-out results from excessive backtracking, your exception handler should abandon the attempt to match the input and inform the user that a time-out has occurred in the regular expression pattern-matching method. Jeśli to możliwe, informacje o wzorcu wyrażenia regularnego, które są dostępne z właściwości Pattern i dane wejściowe, które spowodowały nadmierne wycofywanie, które są dostępne z właściwości Input, powinny być rejestrowane, aby można było zbadać problem i zmodyfikować wzorzec wyrażenia regularnego.If possible, information about the regular expression pattern, which is available from the Pattern property, and the input that caused excessive backtracking, which is available from the Input property, should be logged so that the issue can be investigated and the regular expression pattern modified. Limity czasu wynikające ze zbyt dużej liczby operacji wycofywania są zawsze odtwarzalne.Time-outs due to excessive backtracking are always reproducible.

  • Jeśli limit czasu wynika z ustawienia zbyt niskiej wartości progu limitu czasu, można zwiększyć interwał limitu czasu i ponownie wykonać operację dopasowywania.If the time-out results from setting the time-out threshold too low, you can increase the time-out interval and retry the matching operation. Bieżący interwał limitu czasu jest dostępny z właściwości MatchTimeout.The current time-out interval is available from the MatchTimeout property. Gdy zostanie zgłoszony wyjątek RegexMatchTimeoutException, aparat wyrażeń regularnych utrzymuje swój stan, tak aby wszystkie przyszłe wywołania zwracały ten sam wynik, tak jakby wyjątek nie wystąpił.When a RegexMatchTimeoutException exception is thrown, the regular expression engine maintains its state so that any future invocations return the same result, as if the exception did not occur. Zalecany wzorzec polega na krótkim, losowym przedziale czasu po zgłoszeniu wyjątku przed ponownym wywołaniem metody dopasowywania.The recommended pattern is to wait for a brief, random time interval after the exception is thrown before calling the matching method again. Można to powtórzyć kilka razy.This can be repeated several times. Jednak liczba powtórzeń powinna być mała, jeśli limit czasu jest spowodowany przez nadmierne śledzenie.However, the number of repetitions should be small in case the time-out is caused by excessive backtracking.

W przykładzie w następnej sekcji przedstawiono obie techniki obsługi RegexMatchTimeoutException.The example in the next section illustrates both techniques for handling a RegexMatchTimeoutException.

Konstruktory

RegexMatchTimeoutException()

Inicjuje nowe wystąpienie klasy RegexMatchTimeoutException z komunikatem dostarczonym przez system.Initializes a new instance of the RegexMatchTimeoutException class with a system-supplied message.

RegexMatchTimeoutException(SerializationInfo, StreamingContext)

Inicjuje nowe wystąpienie klasy RegexMatchTimeoutException z zserializowanymi danymi.Initializes a new instance of the RegexMatchTimeoutException class with serialized data.

RegexMatchTimeoutException(String)

Inicjuje nowe wystąpienie klasy RegexMatchTimeoutException z określonym ciągiem komunikatów.Initializes a new instance of the RegexMatchTimeoutException class with the specified message string.

RegexMatchTimeoutException(String, Exception)

Inicjuje nowe wystąpienie klasy RegexMatchTimeoutException z określonym komunikatem o błędzie i odwołaniem do wyjątku wewnętrznego, który jest przyczyną tego wyjątku.Initializes a new instance of the RegexMatchTimeoutException class with a specified error message and a reference to the inner exception that is the cause of this exception.

RegexMatchTimeoutException(String, String, TimeSpan)

Inicjuje nowe wystąpienie klasy RegexMatchTimeoutException z informacjami na temat wzorca wyrażenia regularnego, tekstu wejściowego i interwału limitu czasu.Initializes a new instance of the RegexMatchTimeoutException class with information about the regular expression pattern, the input text, and the time-out interval.

Właściwości

Data

Pobiera kolekcję par klucz/wartość, które zawierają dodatkowe informacje zdefiniowane przez użytkownika dotyczące wyjątku.Gets a collection of key/value pairs that provide additional user-defined information about the exception.

(Odziedziczone po Exception)
HelpLink

Pobiera lub ustawia link do pliku pomocy skojarzonego z tym wyjątkiem.Gets or sets a link to the help file associated with this exception.

(Odziedziczone po Exception)
HResult

Pobiera lub ustawia wartość HRESULT, kodowane wartości liczbowe przypisane do określonego wyjątku.Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception.

(Odziedziczone po Exception)
InnerException

Pobiera wystąpienie Exception, które spowodowało wyjątek bieżący.Gets the Exception instance that caused the current exception.

(Odziedziczone po Exception)
Input

Pobiera tekst wejściowy, który aparat wyrażeń regularnych przetworzył po przekroczeniu limitu czasu.Gets the input text that the regular expression engine was processing when the time-out occurred.

MatchTimeout

Pobiera interwał limitu czasu dla dopasowania wyrażenia regularnego.Gets the time-out interval for a regular expression match.

Message

Pobiera komunikat, który opisuje bieżący wyjątek.Gets a message that describes the current exception.

(Odziedziczone po Exception)
Pattern

Pobiera wzorzec wyrażenia regularnego, który został użyty w operacji dopasowywania po przekroczeniu limitu czasu.Gets the regular expression pattern that was used in the matching operation when the time-out occurred.

Source

Pobiera lub ustawia nazwę aplikacji lub obiekt, który powoduje błąd.Gets or sets the name of the application or the object that causes the error.

(Odziedziczone po Exception)
StackTrace

Pobiera ciąg reprezentujący bezpośrednie ramki w stosie wywołań.Gets a string representation of the immediate frames on the call stack.

(Odziedziczone po Exception)
TargetSite

Pobiera metodę, która zgłasza bieżący wyjątek.Gets the method that throws the current exception.

(Odziedziczone po Exception)

Metody

Equals(Object)

Określa, czy dany obiekt jest taki sam, jak bieżący obiekt.Determines whether the specified object is equal to the current object.

(Odziedziczone po Object)
GetBaseException()

Gdy jest zastępowany w klasie pochodnej, zwraca Exception, który jest główną przyczyną jednego lub kilku kolejnych wyjątków.When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions.

(Odziedziczone po Exception)
GetHashCode()

Służy jako domyślna funkcja skrótu.Serves as the default hash function.

(Odziedziczone po Object)
GetObjectData(SerializationInfo, StreamingContext)

Gdy jest zastępowany w klasie pochodnej, ustawia SerializationInfo z informacjami o wyjątku.When overridden in a derived class, sets the SerializationInfo with information about the exception.

(Odziedziczone po Exception)
GetType()

Pobiera typ środowiska uruchomieniowego bieżącego wystąpienia.Gets the runtime type of the current instance.

(Odziedziczone po Exception)
MemberwiseClone()

Tworzy skróconą kopię bieżącego Object.Creates a shallow copy of the current Object.

(Odziedziczone po Object)
ToString()

Tworzy i zwraca reprezentację ciągu bieżącego wyjątku.Creates and returns a string representation of the current exception.

(Odziedziczone po Exception)

Zdarzenia

SerializeObjectState

Występuje, gdy wyjątek jest serializowany w celu utworzenia obiektu stanu wyjątku, który zawiera serializowane dane dotyczące wyjątku.Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception.

(Odziedziczone po Exception)

Jawne implementacje interfejsu

ISerializable.GetObjectData(SerializationInfo, StreamingContext)

Wypełnia obiekt SerializationInfo danymi wymaganymi do serializacji obiektu RegexMatchTimeoutException.Populates a SerializationInfo object with the data needed to serialize a RegexMatchTimeoutException object.

Dotyczy

Zobacz też