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)

Исходный код:

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

Значение true, если элемент item удалось добавить в коллекцию в течение указанного времени; в противном случае значение false. Если элемент является дубликатом, а соответствующая коллекция не поддерживает повторяющиеся элементы, создается исключение InvalidOperationException.

Исключения

ObjectDisposedException

Объект BlockingCollection<T> удален.

ArgumentOutOfRangeException

Параметр millisecondsTimeout является отрицательным числом, отличным от –1, что означает бесконечное время ожидания.

InvalidOperationException

Коллекция BlockingCollection<T> была помечена как завершенная в отношении добавлений.

-или-

Указанная коллекция не принимает такой элемент.

См. также раздел

• Потокобезопасные коллекции
• Общие сведения о коллекции BlockingCollection

TryAdd(T, Int32, CancellationToken)

Исходный код:

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

Значение true, если элемент item удалось добавить в коллекцию в течение указанного времени; в противном случае значение false. Если элемент является дубликатом, а соответствующая коллекция не поддерживает повторяющиеся элементы, создается исключение InvalidOperationException.

Исключения

OperationCanceledException

CancellationToken отменен.

ObjectDisposedException

Объект BlockingCollection<T> был удален или базовый объект CancellationTokenSource был удален.

ArgumentOutOfRangeException

Параметр millisecondsTimeout является отрицательным числом, отличным от –1, что означает бесконечное время ожидания.

InvalidOperationException

Коллекция BlockingCollection<T> была помечена как завершенная в отношении добавлений.

-или-

Указанная коллекция не принимает такой элемент.

См. также раздел

• Потокобезопасные коллекции
• Общие сведения о коллекции BlockingCollection

TryAdd(T)

Исходный код:

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

Значение true, если item удалось добавить; в противном случае — значение false. Если элемент является дубликатом, а соответствующая коллекция не поддерживает повторяющиеся элементы, создается исключение InvalidOperationException.

Исключения

ObjectDisposedException

Объект BlockingCollection<T> удален.

InvalidOperationException

Коллекция BlockingCollection<T> была помечена как завершенная в отношении добавлений.

-или-

Указанная коллекция не принимает такой элемент.

Комментарии

Если коллекция является ограниченной и заполненной, этот метод немедленно возвращает значение false без добавления элемента.

См. также раздел

• Потокобезопасные коллекции
• Общие сведения о коллекции BlockingCollection

TryAdd(T, TimeSpan)

Исходный код:

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, представляющий время ожидания в миллисекундах, или период TimeSpan, представляющий -1 миллисекунду для неограниченного ожидания.

Возвращаемое значение

Boolean

Значение true, если элемент item удалось добавить в коллекцию в течение указанного промежутка времени; в противном случае значение false.

Исключения

ObjectDisposedException

Объект BlockingCollection<T> удален.

ArgumentOutOfRangeException

timeout — отрицательное число, отличное от –1 миллисекунда, которое представляет бесконечное время ожидания.

-или-

timeout больше , чем Int32.MaxValue.

InvalidOperationException

Коллекция BlockingCollection<T> была помечена как завершенная в отношении добавлений.

-или-

Указанная коллекция не принимает такой элемент.

См. также раздел

• Потокобезопасные коллекции
• Общие сведения о коллекции BlockingCollection