WaitHandle.WaitAny Método

Definición

Espacio de nombres:

System.Threading

Ensamblado:

System.Runtime.dll

Espera a que cualquiera de los elementos de la matriz especificada reciba una señal.

Sobrecargas

WaitAny(WaitHandle[])	Espera a que cualquiera de los elementos de la matriz especificada reciba una señal.
WaitAny(WaitHandle[], Int32)	Espera a que cualquiera de los elementos de la matriz especificada reciba una señal, utilizando un entero de 32 bits con signo para especificar el intervalo de tiempo.
WaitAny(WaitHandle[], TimeSpan)	Espera a que cualquiera de los elementos de la matriz especificada reciba una señal, usando un TimeSpan para especificar el intervalo de tiempo.
WaitAny(WaitHandle[], Int32, Boolean)	Espera a que cualquiera de los elementos de la matriz especificada reciba una señal; utiliza un entero de 32 bits con signo para determinar el intervalo de tiempo y especifica si se va a salir del dominio de sincronización antes de la espera.
WaitAny(WaitHandle[], TimeSpan, Boolean)	Espera a que cualquiera de los elementos de la matriz especificada reciba una señal; usa un TimeSpan para especificar el intervalo de tiempo y especifica si se va a salir del dominio de sincronización antes de la espera.

WaitAny(WaitHandle[])

Source:

WaitHandle.cs

Espera a que cualquiera de los elementos de la matriz especificada reciba una señal.

C#

public static int WaitAny (System.Threading.WaitHandle[] waitHandles);

Parámetros

waitHandles

WaitHandle[]

Matriz WaitHandle que contiene los objetos por los que la instancia actual esperará.

Devoluciones

Int32

Índice de la matriz del objeto que satisfizo la espera.

Excepciones

ArgumentNullException

El parámetro waitHandles es null.

o bien

Uno o varios objetos de la matriz waitHandles son null.

NotSupportedException

El número de objetos de waitHandles es mayor de lo que permite el sistema.

ApplicationException

waitHandles es una matriz sin elementos y la versión de .NET Framework es 1.0 o 1.1.

AbandonedMutexException

La espera finalizó porque un subproceso se cierra sin liberar una exclusión mutua.

ArgumentException

waitHandles es una matriz sin elementos y la versión de .NET Framework es 2.0 o posterior.

InvalidOperationException

La matriz waitHandles contiene un proxy transparente para un WaitHandle en otro dominio de aplicación.

Ejemplos

En el ejemplo de código siguiente se muestra cómo llamar al WaitAny método .

C#

using System;
using System.Threading;

public sealed class App
{
    // Define an array with two AutoResetEvent WaitHandles.
    static WaitHandle[] waitHandles = new WaitHandle[]
    {
        new AutoResetEvent(false),
        new AutoResetEvent(false)
    };

    // Define a random number generator for testing.
    static Random r = new Random();

    static void Main()
    {
        // Queue up two tasks on two different threads;
        // wait until all tasks are completed.
        DateTime dt = DateTime.Now;
        Console.WriteLine("Main thread is waiting for BOTH tasks to complete.");
        ThreadPool.QueueUserWorkItem(new WaitCallback(DoTask), waitHandles[0]);
        ThreadPool.QueueUserWorkItem(new WaitCallback(DoTask), waitHandles[1]);
        WaitHandle.WaitAll(waitHandles);
        // The time shown below should match the longest task.
        Console.WriteLine("Both tasks are completed (time waited={0})",
            (DateTime.Now - dt).TotalMilliseconds);

        // Queue up two tasks on two different threads;
        // wait until any task is completed.
        dt = DateTime.Now;
        Console.WriteLine();
        Console.WriteLine("The main thread is waiting for either task to complete.");
        ThreadPool.QueueUserWorkItem(new WaitCallback(DoTask), waitHandles[0]);
        ThreadPool.QueueUserWorkItem(new WaitCallback(DoTask), waitHandles[1]);
        int index = WaitHandle.WaitAny(waitHandles);
        // The time shown below should match the shortest task.
        Console.WriteLine("Task {0} finished first (time waited={1}).",
            index + 1, (DateTime.Now - dt).TotalMilliseconds);
    }

    static void DoTask(Object state)
    {
        AutoResetEvent are = (AutoResetEvent) state;
        int time = 1000 * r.Next(2, 10);
        Console.WriteLine("Performing a task for {0} milliseconds.", time);
        Thread.Sleep(time);
        are.Set();
    }
}

// This code produces output similar to the following:
//
//  Main thread is waiting for BOTH tasks to complete.
//  Performing a task for 7000 milliseconds.
//  Performing a task for 4000 milliseconds.
//  Both tasks are completed (time waited=7064.8052)
//
//  The main thread is waiting for either task to complete.
//  Performing a task for 2000 milliseconds.
//  Performing a task for 2000 milliseconds.
//  Task 1 finished first (time waited=2000.6528).

Comentarios

AbandonedMutexException es nuevo en .NET Framework versión 2.0. En versiones anteriores, el WaitAny método devuelve true si se completa la espera porque se abandona una exclusión mutua. Una exclusión mutua abandonada suele indicar un error de codificación grave. En el caso de una exclusión mutua en todo el sistema, puede indicar que una aplicación se ha terminado abruptamente (por ejemplo, mediante el Administrador de tareas de Windows). La excepción contiene información útil para la depuración.

El WaitAny método produce un AbandonedMutexException solo cuando se completa la espera debido a una exclusión mutua abandonada. Si waitHandles contiene una exclusión mutua liberado con un número de índice menor que la exclusión mutua abandonada, el WaitAny método se completa normalmente y la excepción no se inicia.

Nota

En versiones de .NET Framework anteriores a la versión 2.0, si un subproceso sale o anula sin liberar explícitamente un Mutexy que Mutex se encuentra en el índice 0 (cero) de una WaitAny matriz en otro subproceso, el índice devuelto por WaitAny es 128 en lugar de 0.

Este método devuelve cuando se señala cualquier identificador. Si se señala más de un objeto durante la llamada, el valor devuelto es el índice de matriz del objeto señalado con el valor de índice más pequeño de todos los objetos señalados.

El número máximo de identificadores de espera es 64 y 63 si el subproceso actual está en STA estado.

Llamar a esta sobrecarga de método equivale a llamar a la sobrecarga del WaitAny(WaitHandle[], Int32, Boolean) método y especificar -1 (o Timeout.Infinite) para millisecondsTimeout y true para exitContext.

WaitAny(WaitHandle[], Int32)

Source:

WaitHandle.cs

Espera a que cualquiera de los elementos de la matriz especificada reciba una señal, utilizando un entero de 32 bits con signo para especificar el intervalo de tiempo.

C#

public static int WaitAny (System.Threading.WaitHandle[] waitHandles, int millisecondsTimeout);

Parámetros

waitHandles

WaitHandle[]

Matriz WaitHandle que contiene los objetos por los que la instancia actual esperará.

millisecondsTimeout

Int32

Número de milisegundos de espera o Infinite (-1) para esperar indefinidamente.

Devoluciones

Int32

Índice de matriz del objeto que satisfizo la espera o WaitTimeout si ningún objeto satisfizo la espera y transcurrió un intervalo de tiempo equivalente a millisecondsTimeout.

Excepciones

ArgumentNullException

El parámetro waitHandles es null.

o bien

Uno o varios objetos de la matriz waitHandles son null.

NotSupportedException

El número de objetos de waitHandles es mayor de lo que permite el sistema.

ArgumentOutOfRangeException

millisecondsTimeout es un número negativo distinto de-1, que representa un tiempo de espera infinito.

AbandonedMutexException

La espera finalizó porque un subproceso se cierra sin liberar una exclusión mutua.

ArgumentException

waitHandles es una matriz sin elementos.

InvalidOperationException

La matriz waitHandles contiene un proxy transparente para un WaitHandle en otro dominio de aplicación.

Comentarios

Si millisecondsTimeout es cero, el método no se bloquea. Comprueba el estado de los identificadores de espera y devuelve inmediatamente.

El WaitAny método produce un AbandonedMutexException solo cuando se completa la espera debido a una exclusión mutua abandonada. Si waitHandles contiene una exclusión mutua liberado con un número de índice menor que la exclusión mutua abandonada, el WaitAny método se completa normalmente y la excepción no se inicia.

Este método devuelve cuando finaliza la espera, ya sea cuando se señala cualquiera de los identificadores o cuando se produce un tiempo de espera. Si se señala más de un objeto durante la llamada, el valor devuelto es el índice de matriz del objeto señalado con el valor de índice más pequeño de todos los objetos señalados.

El número máximo de identificadores de espera es 64 y 63 si el subproceso actual está en STA estado.

Llamar a esta sobrecarga de método es la misma que llamar a la WaitAny(WaitHandle[], Int32, Boolean) sobrecarga y especificar false para exitContext.

WaitAny(WaitHandle[], TimeSpan)

Source:

WaitHandle.cs

Espera a que cualquiera de los elementos de la matriz especificada reciba una señal, usando un TimeSpan para especificar el intervalo de tiempo.

C#

public static int WaitAny (System.Threading.WaitHandle[] waitHandles, TimeSpan timeout);

Parámetros

waitHandles

WaitHandle[]

Matriz WaitHandle que contiene los objetos por los que la instancia actual esperará.

timeout

TimeSpan

Estructura TimeSpan que representa el número de milisegundos de espera o estructura TimeSpan que representa -1 milisegundos para esperar indefinidamente.

Devoluciones

Int32

Índice de matriz del objeto que satisfizo la espera o WaitTimeout si ningún objeto satisfizo la espera y transcurrió un intervalo de tiempo equivalente a timeout.

Excepciones

ArgumentNullException

El parámetro waitHandles es null.

o bien

Uno o varios objetos de la matriz waitHandles son null.

NotSupportedException

El número de objetos de waitHandles es mayor de lo que permite el sistema.

ArgumentOutOfRangeException

timeout es un número negativo distinto de -1 milisegundos, que representa un tiempo de espera infinito.

O bien

timeout es mayor que Int32.MaxValue.

AbandonedMutexException

La espera finalizó porque un subproceso se cierra sin liberar una exclusión mutua.

ArgumentException

waitHandles es una matriz sin elementos.

InvalidOperationException

La matriz waitHandles contiene un proxy transparente para un WaitHandle en otro dominio de aplicación.

Comentarios

Si timeout es cero, el método no se bloquea. Comprueba el estado de los identificadores de espera y devuelve inmediatamente.

El WaitAny método produce un AbandonedMutexException solo cuando se completa la espera debido a una exclusión mutua abandonada. Si waitHandles contiene una exclusión mutua liberado con un número de índice menor que la exclusión mutua abandonada, el WaitAny método se completa normalmente y la excepción no se inicia.

Este método devuelve cuando finaliza la espera, ya sea cuando se señala cualquiera de los identificadores o cuando se produce un tiempo de espera. Si se señala más de un objeto durante la llamada, el valor devuelto es el índice de matriz del objeto señalado con el valor de índice más pequeño de todos los objetos señalados.

El número máximo de identificadores de espera es 64 y 63 si el subproceso actual está en STA estado.

El valor máximo de timeout es Int32.MaxValue.

Llamar a esta sobrecarga de método es la misma que llamar a la WaitAny(WaitHandle[], TimeSpan, Boolean) sobrecarga y especificar false para exitContext.

WaitAny(WaitHandle[], Int32, Boolean)

Source:

WaitHandle.cs

Espera a que cualquiera de los elementos de la matriz especificada reciba una señal; utiliza un entero de 32 bits con signo para determinar el intervalo de tiempo y especifica si se va a salir del dominio de sincronización antes de la espera.

C#

public static int WaitAny (System.Threading.WaitHandle[] waitHandles, int millisecondsTimeout, bool exitContext);

Parámetros

waitHandles

WaitHandle[]

Matriz WaitHandle que contiene los objetos por los que la instancia actual esperará.

millisecondsTimeout

Int32

Número de milisegundos de espera o Infinite (-1) para esperar indefinidamente.

exitContext

Boolean

true para salir del dominio de sincronización del contexto antes de la espera (en caso de encontrarse en un contexto sincronizado) y volver a adquirirlo más tarde; de lo contrario, false.

Devoluciones

Int32

Índice de matriz del objeto que satisfizo la espera o WaitTimeout si ningún objeto satisfizo la espera y transcurrió un intervalo de tiempo equivalente a millisecondsTimeout.

Excepciones

ArgumentNullException

El parámetro waitHandles es null.

o bien

Uno o varios objetos de la matriz waitHandles son null.

NotSupportedException

El número de objetos de waitHandles es mayor de lo que permite el sistema.

ApplicationException

waitHandles es una matriz sin elementos y la versión de .NET Framework es 1.0 o 1.1.

ArgumentOutOfRangeException

millisecondsTimeout es un número negativo distinto de-1, que representa un tiempo de espera infinito.

AbandonedMutexException

La espera finalizó porque un subproceso se cierra sin liberar una exclusión mutua.

ArgumentException

waitHandles es una matriz sin elementos y la versión de .NET Framework es 2.0 o posterior.

InvalidOperationException

La matriz waitHandles contiene un proxy transparente para un WaitHandle en otro dominio de aplicación.

Ejemplos

En el ejemplo de código siguiente se muestra cómo usar el grupo de subprocesos para buscar simultáneamente un archivo en varios discos. Para tener en cuenta el espacio, solo se busca en el directorio raíz de cada disco.

C#

using System;
using System.IO;
using System.Threading;

class Test
{
    static void Main()
    {
        Search search = new Search();
        search.FindFile("SomeFile.dat");
    }
}

class Search
{
    // Maintain state information to pass to FindCallback.
    class State
    {
        public AutoResetEvent autoEvent;
        public string         fileName;

        public State(AutoResetEvent autoEvent, string fileName)
        {
            this.autoEvent    = autoEvent;
            this.fileName     = fileName;
        }
    }

    AutoResetEvent[] autoEvents;
    String[] diskLetters;

    public Search()
    {
        // Retrieve an array of disk letters.
        diskLetters = Environment.GetLogicalDrives();

        autoEvents = new AutoResetEvent[diskLetters.Length];
        for(int i = 0; i < diskLetters.Length; i++)
        {
            autoEvents[i] = new AutoResetEvent(false);
        }
    }

    // Search for fileName in the root directory of all disks.
    public void FindFile(string fileName)
    {
        for(int i = 0; i < diskLetters.Length; i++)
        {
            Console.WriteLine("Searching for {0} on {1}.",
                fileName, diskLetters[i]);
            ThreadPool.QueueUserWorkItem(
                new WaitCallback(FindCallback), 
                new State(autoEvents[i], diskLetters[i] + fileName));
        }

        // Wait for the first instance of the file to be found.
        int index = WaitHandle.WaitAny(autoEvents, 3000, false);
        if(index == WaitHandle.WaitTimeout)
        {
            Console.WriteLine("\n{0} not found.", fileName);
        }
        else
        {
            Console.WriteLine("\n{0} found on {1}.", fileName,
                diskLetters[index]);
        }
    }

    // Search for stateInfo.fileName.
    void FindCallback(object state)
    {
        State stateInfo = (State)state;

        // Signal if the file is found.
        if(File.Exists(stateInfo.fileName))
        {
            stateInfo.autoEvent.Set();
        }
    }
}

Comentarios

Si millisecondsTimeout es cero, el método no se bloquea. Comprueba el estado de los identificadores de espera y devuelve inmediatamente.

El WaitAny método produce un AbandonedMutexException solo cuando se completa la espera debido a una exclusión mutua abandonada. Si waitHandles contiene una exclusión mutua liberado con un número de índice menor que la exclusión mutua abandonada, el WaitAny método se completa normalmente y la excepción no se inicia. Una exclusión mutua abandonada suele indicar un error de codificación grave. En el caso de una exclusión mutua en todo el sistema, puede indicar que una aplicación se ha terminado abruptamente (por ejemplo, mediante el Administrador de tareas de Windows). La excepción contiene información útil para la depuración.

Este método devuelve cuando finaliza la espera, ya sea cuando se señala cualquiera de los identificadores o cuando se produce un tiempo de espera. Si se señala más de un objeto durante la llamada, el valor devuelto es el índice de matriz del objeto señalado con el valor de índice más pequeño de todos los objetos señalados.

El número máximo de identificadores de espera es 64 y 63 si el subproceso actual está en STA estado.

Salir del contexto

El exitContext parámetro no tiene ningún efecto a menos que se llame a este método desde dentro de un contexto administrado no predeterminado. El contexto administrado puede ser no predeterminado si el subproceso está dentro de una llamada a una instancia de una clase derivada de ContextBoundObject. Incluso si actualmente está ejecutando un método en una clase que no se deriva de ContextBoundObject, como String, puede estar en un contexto no predeterminado si ContextBoundObject está en la pila en el dominio de aplicación actual.

Cuando el código se ejecuta en un contexto no predeterminado, al especificar true para exitContext que el subproceso salga del contexto administrado no predeterminado (es decir, para realizar la transición al contexto predeterminado) antes de ejecutar este método. El subproceso vuelve al contexto no predeterminado original una vez completada la llamada a este método.

Salir del contexto puede ser útil cuando la clase enlazada al contexto tiene el SynchronizationAttribute atributo . En ese caso, todas las llamadas a los miembros de la clase se sincronizan automáticamente y el dominio de sincronización es todo el cuerpo de código de la clase. Si el código de la pila de llamadas de un miembro llama a este método y especifica para exitContext, el subproceso true sale del dominio de sincronización, lo que permite que un subproceso bloqueado en una llamada a cualquier miembro del objeto continúe. Cuando este método vuelve, el subproceso que realizó la llamada debe esperar a volver a escribir el dominio de sincronización.

WaitAny(WaitHandle[], TimeSpan, Boolean)

Source:

WaitHandle.cs

Espera a que cualquiera de los elementos de la matriz especificada reciba una señal; usa un TimeSpan para especificar el intervalo de tiempo y especifica si se va a salir del dominio de sincronización antes de la espera.

C#

public static int WaitAny (System.Threading.WaitHandle[] waitHandles, TimeSpan timeout, bool exitContext);

Parámetros

waitHandles

WaitHandle[]

Matriz WaitHandle que contiene los objetos por los que la instancia actual esperará.

timeout

TimeSpan

Estructura TimeSpan que representa el número de milisegundos de espera o estructura TimeSpan que representa -1 milisegundos para esperar indefinidamente.

exitContext

Boolean

true para salir del dominio de sincronización del contexto antes de la espera (en caso de encontrarse en un contexto sincronizado) y volver a adquirirlo más tarde; de lo contrario, false.

Devoluciones

Int32

Índice de matriz del objeto que satisfizo la espera o WaitTimeout si ningún objeto satisfizo la espera y transcurrió un intervalo de tiempo equivalente a timeout.

Excepciones

ArgumentNullException

El parámetro waitHandles es null.

o bien

Uno o varios objetos de la matriz waitHandles son null.

NotSupportedException

El número de objetos de waitHandles es mayor de lo que permite el sistema.

ApplicationException

waitHandles es una matriz sin elementos y la versión de .NET Framework es 1.0 o 1.1.

ArgumentOutOfRangeException

timeout es un número negativo distinto de -1 milisegundos, que representa un tiempo de espera infinito.

O bien

timeout es mayor que Int32.MaxValue.

AbandonedMutexException

La espera finalizó porque un subproceso se cierra sin liberar una exclusión mutua.

ArgumentException

waitHandles es una matriz sin elementos y la versión de .NET Framework es 2.0 o posterior.

InvalidOperationException

La matriz waitHandles contiene un proxy transparente para un WaitHandle en otro dominio de aplicación.

Ejemplos

En el ejemplo de código siguiente se muestra cómo usar el grupo de subprocesos para buscar simultáneamente un archivo en varios discos. Para tener en cuenta el espacio, solo se busca en el directorio raíz de cada disco.

C#

using System;
using System.IO;
using System.Threading;

class Test
{
    static void Main()
    {
        Search search = new Search();
        search.FindFile("SomeFile.dat");
    }
}

class Search
{
    // Maintain state information to pass to FindCallback.
    class State
    {
        public AutoResetEvent autoEvent;
        public string         fileName;

        public State(AutoResetEvent autoEvent, string fileName)
        {
            this.autoEvent    = autoEvent;
            this.fileName     = fileName;
        }
    }

    AutoResetEvent[] autoEvents;
    String[] diskLetters;

    public Search()
    {
        // Retrieve an array of disk letters.
        diskLetters = Environment.GetLogicalDrives();

        autoEvents = new AutoResetEvent[diskLetters.Length];
        for(int i = 0; i < diskLetters.Length; i++)
        {
            autoEvents[i] = new AutoResetEvent(false);
        }
    }

    // Search for fileName in the root directory of all disks.
    public void FindFile(string fileName)
    {
        for(int i = 0; i < diskLetters.Length; i++)
        {
            Console.WriteLine("Searching for {0} on {1}.",
                fileName, diskLetters[i]);
            ThreadPool.QueueUserWorkItem(
                new WaitCallback(FindCallback), 
                new State(autoEvents[i], diskLetters[i] + fileName));
        }

        // Wait for the first instance of the file to be found.
        int index = WaitHandle.WaitAny(
            autoEvents, new TimeSpan(0, 0, 3), false);
        if(index == WaitHandle.WaitTimeout)
        {
            Console.WriteLine("\n{0} not found.", fileName);
        }
        else
        {
            Console.WriteLine("\n{0} found on {1}.", fileName,
                diskLetters[index]);
        }
    }

    // Search for stateInfo.fileName.
    void FindCallback(object state)
    {
        State stateInfo = (State)state;

        // Signal if the file is found.
        if(File.Exists(stateInfo.fileName))
        {
            stateInfo.autoEvent.Set();
        }
    }
}

Comentarios

Si timeout es cero, el método no se bloquea. Comprueba el estado de los identificadores de espera y devuelve inmediatamente.

El WaitAny método produce un AbandonedMutexException solo cuando se completa la espera debido a una exclusión mutua abandonada. Si waitHandles contiene una exclusión mutua liberado con un número de índice menor que la exclusión mutua abandonada, el WaitAny método se completa normalmente y la excepción no se inicia. Una exclusión mutua abandonada suele indicar un error de codificación grave. En el caso de una exclusión mutua en todo el sistema, puede indicar que una aplicación se ha terminado abruptamente (por ejemplo, mediante el Administrador de tareas de Windows). La excepción contiene información útil para la depuración.

Este método devuelve cuando finaliza la espera, ya sea cuando se señala cualquiera de los identificadores o cuando se produce un tiempo de espera. Si se señala más de un objeto durante la llamada, el valor devuelto es el índice de matriz del objeto señalado con el valor de índice más pequeño de todos los objetos señalados.

El número máximo de identificadores de espera es 64 y 63 si el subproceso actual está en STA estado.

El valor máximo de timeout es Int32.MaxValue.

Salir del contexto

El exitContext parámetro no tiene ningún efecto a menos que se llame a este método desde dentro de un contexto administrado no predeterminado. El contexto administrado puede ser no predeterminado si el subproceso está dentro de una llamada a una instancia de una clase derivada de ContextBoundObject. Incluso si actualmente está ejecutando un método en una clase que no se deriva de ContextBoundObject, como String, puede estar en un contexto no predeterminado si ContextBoundObject está en la pila en el dominio de aplicación actual.

Cuando el código se ejecuta en un contexto no predeterminado, al especificar true para exitContext que el subproceso salga del contexto administrado no predeterminado (es decir, para realizar la transición al contexto predeterminado) antes de ejecutar este método. El subproceso vuelve al contexto no predeterminado original una vez completada la llamada a este método.

Salir del contexto puede ser útil cuando la clase enlazada al contexto tiene el SynchronizationAttribute atributo . En ese caso, todas las llamadas a los miembros de la clase se sincronizan automáticamente y el dominio de sincronización es todo el cuerpo de código de la clase. Si el código de la pila de llamadas de un miembro llama a este método y especifica para exitContext, el subproceso true sale del dominio de sincronización, lo que permite que un subproceso bloqueado en una llamada a cualquier miembro del objeto continúe. Cuando este método vuelve, el subproceso que realizó la llamada debe esperar a volver a escribir el dominio de sincronización.