BlockingCollection<T>.TryAdd Método

Definição

Namespace:

System.Collections.Concurrent

Assembly:

System.Collections.Concurrent.dll

Tenta adicionar o item especificado ao BlockingCollection<T>.

Sobrecargas

TryAdd(T, Int32)	Tenta adicionar o item especificado à BlockingCollection<T> dentro do período de tempo especificado.
TryAdd(T, Int32, CancellationToken)	Tenta adicionar o item especificado ao BlockingCollection<T> no período especificado, enquanto observa um token de cancelamento.
TryAdd(T)	Tenta adicionar o item especificado ao BlockingCollection<T>.
TryAdd(T, TimeSpan)	Tenta adicionar o item especificado ao BlockingCollection<T>.

TryAdd(T, Int32)

Origem:

BlockingCollection.cs

Tenta adicionar o item especificado à BlockingCollection<T> dentro do período de tempo especificado.

public:
 bool TryAdd(T item, int millisecondsTimeout);

public bool TryAdd (T item, int millisecondsTimeout);

member this.TryAdd : 'T * int -> bool

Public Function TryAdd (item As T, millisecondsTimeout As Integer) As Boolean

Parâmetros

item

T

O item a ser adicionado à coleção.

millisecondsTimeout

Int32

O número de milissegundos a aguardar até que a coleção aceite o item ou Infinite (-1) aguarde indefinidamente.

Retornos

Boolean

true se o item puder ser adicionado à coleção dentro do tempo especificado, caso contrário, false. Se o item for duplicado e a coleção subjacente não aceitar itens duplicados, será gerada uma InvalidOperationException.

Exceções

ObjectDisposedException

O BlockingCollection<T> foi descartado.

ArgumentOutOfRangeException

millisecondsTimeout é um número negativo diferente de -1, que representa um tempo limite infinito.

InvalidOperationException

O BlockingCollection<T> foi marcado como concluído com relação a adições.

- ou -

A coleção subjacente não aceitou o item.

Confira também

• Coleções Thread-Safe
• Visão geral de BlockingCollection

TryAdd(T, Int32, CancellationToken)

Origem:

BlockingCollection.cs

Tenta adicionar o item especificado ao BlockingCollection<T> no período especificado, enquanto observa um token de cancelamento.

public:
 bool TryAdd(T item, int millisecondsTimeout, System::Threading::CancellationToken cancellationToken);

public bool TryAdd (T item, int millisecondsTimeout, System.Threading.CancellationToken cancellationToken);

member this.TryAdd : 'T * int * System.Threading.CancellationToken -> bool

Public Function TryAdd (item As T, millisecondsTimeout As Integer, cancellationToken As CancellationToken) As Boolean

Parâmetros

item

T

O item a ser adicionado à coleção.

millisecondsTimeout

Int32

O número de milissegundos a aguardar até que a coleção aceite o item ou Infinite (-1) aguarde indefinidamente.

cancellationToken

CancellationToken

Um token de cancelamento a ser observado.

Retornos

Boolean

true se o item puder ser adicionado à coleção dentro do tempo especificado, caso contrário, false. Se o item for duplicado e a coleção subjacente não aceitar itens duplicados, será gerada uma InvalidOperationException.

Exceções

OperationCanceledException

O CancellationToken está cancelado.

ObjectDisposedException

O BlockingCollection<T> foi descartado ou o CancellationTokenSource subjacente foi descartado.

ArgumentOutOfRangeException

millisecondsTimeout é um número negativo diferente de -1, que representa um tempo limite infinito.

InvalidOperationException

O BlockingCollection<T> foi marcado como concluído com relação a adições.

- ou -

A coleção subjacente não aceitou o item.

Confira também

• Coleções Thread-Safe
• Visão geral de BlockingCollection

TryAdd(T)

Origem:

BlockingCollection.cs

Tenta adicionar o item especificado ao BlockingCollection<T>.

public:
 bool TryAdd(T item);

public bool TryAdd (T item);

member this.TryAdd : 'T -> bool

Public Function TryAdd (item As T) As Boolean

Parâmetros

item

T

O item a ser adicionado à coleção.

Retornos

Boolean

true se item pôde ser adicionado; caso contrário, false. Se o item for duplicado e a coleção subjacente não aceitar itens duplicados, será gerada uma InvalidOperationException.

Exceções

ObjectDisposedException

O BlockingCollection<T> foi descartado.

InvalidOperationException

O BlockingCollection<T> foi marcado como concluído com relação a adições.

- ou -

A coleção subjacente não aceitou o item.

Comentários

Se a coleção for uma coleção limitada e estiver cheia, esse método retornará false imediatamente sem adicionar o item.

Confira também

• Coleções Thread-Safe
• Visão geral de BlockingCollection

TryAdd(T, TimeSpan)

Origem:

BlockingCollection.cs

Tenta adicionar o item especificado ao BlockingCollection<T>.

public:
 bool TryAdd(T item, TimeSpan timeout);

public bool TryAdd (T item, TimeSpan timeout);

member this.TryAdd : 'T * TimeSpan -> bool

Public Function TryAdd (item As T, timeout As TimeSpan) As Boolean

Parâmetros

item

T

O item a ser adicionado à coleção.

timeout

TimeSpan

Um TimeSpan que representa o número de milissegundos para aguardar ou um TimeSpan que representa -1 milissegundos para aguardar indefinidamente.

Retornos

Boolean

true se o item puder ser adicionado à coleção dentro do tempo especificado, caso contrário, false.

Exceções

ObjectDisposedException

O BlockingCollection<T> foi descartado.

ArgumentOutOfRangeException

timeout é um número negativo diferente de -1 milissegundos, que representa um tempo limite infinito

-ou-

timeout é maior que Int32.MaxValue.

InvalidOperationException

O BlockingCollection<T> foi marcado como concluído com relação a adições.

- ou -

A coleção subjacente não aceitou o item.

Confira também

• Coleções Thread-Safe
• Visão geral de BlockingCollection