BlockingCollection<T>.TryAdd 方法

定义

命名空间:

System.Collections.Concurrent

程序集:

System.Collections.Concurrent.dll

尝试将指定的项添加到 BlockingCollection<T>。

重载

TryAdd(T, Int32)	尝试在指定的时间段内将指定的项添加到 BlockingCollection<T>。
TryAdd(T, Int32, CancellationToken)	在观察取消标记时，尝试在指定的时间段内将指定的项添加到 BlockingCollection<T>。
TryAdd(T)	尝试将指定的项添加到 BlockingCollection<T>。
TryAdd(T, TimeSpan)	尝试将指定的项添加到 BlockingCollection<T>。

TryAdd(T, Int32)

Source:

BlockingCollection.cs

尝试在指定的时间段内将指定的项添加到 BlockingCollection<T>。

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

参数

item

T

要添加到集合的项。

millisecondsTimeout

Int32

等待集合接受项的毫秒数，或 Infinite (-1) 无限期等待。

返回

Boolean

如果在指定的时间内可以将 item 添加到集合中，则为 true；否则为 false。 如果该项有重复，并且基础集合不接受重复项，则会引发 InvalidOperationException。

例外

ObjectDisposedException

已释放了 BlockingCollection<T>。

ArgumentOutOfRangeException

millisecondsTimeout 是一个非 -1 的负数，而 -1 表示无限期超时。

InvalidOperationException

BlockingCollection<T> 已标记为完成添加。

- 或 -

基础集合未接受该项。

另请参阅

• 线程安全集合
• BlockingCollection 概述

TryAdd(T, Int32, CancellationToken)

Source:

BlockingCollection.cs

在观察取消标记时，尝试在指定的时间段内将指定的项添加到 BlockingCollection<T>。

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

参数

item

T

要添加到集合的项。

millisecondsTimeout

Int32

等待集合接受项的毫秒数，或 Infinite (-1) 无限期等待。

cancellationToken

CancellationToken

要观察的取消标记。

返回

Boolean

如果在指定的时间内可以将 item 添加到集合中，则为 true；否则为 false。 如果该项有重复，并且基础集合不接受重复项，则会引发 InvalidOperationException。

例外

OperationCanceledException

CancellationToken 已取消。

ObjectDisposedException

已释放 BlockingCollection<T>，或已释放基础 CancellationTokenSource。

ArgumentOutOfRangeException

millisecondsTimeout 是一个非 -1 的负数，而 -1 表示无限期超时。

InvalidOperationException

BlockingCollection<T> 已标记为完成添加。

- 或 -

基础集合未接受该项。

另请参阅

• 线程安全集合
• BlockingCollection 概述

TryAdd(T)

Source:

BlockingCollection.cs

尝试将指定的项添加到 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

参数

item

T

要添加到集合的项。

返回

Boolean

如果可以添加 item，则返回 true；否则，返回 false。 如果该项有重复，并且基础集合不接受重复项，则会引发 InvalidOperationException。

例外

ObjectDisposedException

已释放了 BlockingCollection<T>。

InvalidOperationException

BlockingCollection<T> 已标记为完成添加。

- 或 -

基础集合未接受该项。

注解

如果集合是有界集合且已满，则此方法将立即返回 false，而不添加该项。

另请参阅

• 线程安全集合
• BlockingCollection 概述

TryAdd(T, TimeSpan)

Source:

BlockingCollection.cs

尝试将指定的项添加到 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

参数

item

T

要添加到集合的项。

timeout

TimeSpan

表示等待毫秒数的 TimeSpan，或表示 -1 毫秒（无限期等待）的 TimeSpan。

返回

Boolean

如果在指定的时间跨度内可以将 item 添加到集合中，则为 true；否则为 false。

例外

ObjectDisposedException

已释放了 BlockingCollection<T>。

ArgumentOutOfRangeException

timeout 是除 -1 毫秒以外的负数，表示无限超时

-或-

timeout 大于 Int32.MaxValue。

InvalidOperationException

BlockingCollection<T> 已标记为完成添加。

- 或 -

基础集合未接受该项。

另请参阅

• 线程安全集合
• BlockingCollection 概述