Герберт Шилдт - C# 4.0: полное руководство

bool TryAdd(Т item)

bool TryTake(out T item)

Метод TryAdd()возвращает логическое значение true, если в коллекцию добавлен элемент item. А метод TryTake()возвращает логическое значение true, если элемент i tem удален из коллекции. Если метод TryAdd()выполнен успешно, то элемент i tem будет содержать объект. (Кроме того, в интерфейсе IProducerConsumerCollectionуказывается перегружаемый вариант метода CopyTo(), определяемого в интерфейсе ICollection, а также метода ТоАггау(), копирующего коллекцию в массив.)

Параллельные коллекции зачастую применяются в комбинации с библиотекой распараллеливания задач (TPL) или языком PLINQ. В силу особого характера этих коллекций все их классы не будут рассматриваться далее подробно. Вместо этого на конкретных примерах будет дан краткий обзор класса BlockingCollection. Усвоив основы построения класса BlockingCollection, вы сможете без особого труда разобраться и в остальных классах параллельных коллекций.

В классе BlockingCollection, по существу, реализуется блокирующая очередь. Это означает, что в такой очереди автоматически устанавливается ожидание любых попыток вставить элемент в коллекцию, когда она заполнена, а также попыток удалить элемент из коллекции, когда она пуста. Это идеальное решение для тех ситуаций, которые связаны с применением шаблона "поставщик-потребитель". В классе BlockingCollectionреализуются интерфейсы ICollection, IEnumerable, IEnumerable, а также IDisposable.

В классе BlockingCollectionопределяются следующие конструкторы.

public BlockingCollection()

public BlockingCollection(int boundedCapacity)

public BlockingCollection(IProducerConsumerCollection collection)

public BlockingCollection(IProducerConsumerCollection collection,

int boundedCapacity)

В двух первых конструкторах в оболочку класса BlockingCollectionзаключается коллекция, являющаяся экземпляром объекта типа ConcurrentQueue. А в двух других конструкторах можно указать коллекцию, которая должна быть положена в основу коллекции типа BlockingCollection. Если указывается параметр boundedCapacity, то он должен содержать максимальное количество объектов, которые коллекция должна содержать перед тем, как она окажется заблокированной. Если же параметр boundedCapacity не указан, то коллекция оказывается неограниченной.

Помимо методов TryAdd()и TryTake(), определяемых параллельно с теми, что указываются в интерфейсе IProducerConsumerCollection, в классе BlockingCollectionопределяется также ряд собственных методов. Ниже представлены методы, которые будут использоваться в приведенных далее примерах.

public void Add(T item)

public T Take()

Когда метод Add()вызывается для неограниченной коллекции, он добавляет элемент item в коллекцию и затем возвращает управление вызывающей части программы. А когда метод Add()вызывается для ограниченной коллекции, он блокирует доступ к ней, если она заполнена. После того как из коллекции будет удален один элемент или больше, указанный элемент item будет добавлен в коллекцию, и затем произойдет возврат из данного метода. Метод Таке()удаляет элемент из коллекции и возвращает управление вызывающей части программы. (Имеются также варианты обоих методов, принимающие в качестве параметра признак задачи как экземпляр объекта типа CancellationToken.)

Применяя методы Add()и Таке(), можно реализовать простой шаблон "поставщик-потребитель", как показано в приведенном ниже примере программы. В этой программе создается поставщик, формирующий символы от А до Z, а также потребитель, получающий эти символы. При этом создается коллекция типа BlockingCollection, ограниченная 4 элементами.

// Простой пример коллекции типа BlockingCollection.

using System;

using System.Threading.Tasks;

using System.Threading;

using System.Collections.Concurrent;

class BlockingDemo {

static BlockingCollection bc;

// Произвести и поставить символы от А до Z.

static void Producer() {

for(char ch = 'A'; ch <= 'Z'; ch++) {

bc.Add(ch);

Console.WriteLine ("Производится символ " + ch) ;

}

}

// Потребить 26 символов,

static void Consumer() {

for(int i=0; i < 26; i++)

Console .WriteLine ("Потребляется символ " + bc.Take());

}

static void Main() {

// Использовать блокирующую коллекцию, ограниченную 4 элементами,

bc = new BlockingCollection(4);

// Создать задачи поставщика и потребителя.

Task Prod = new Task(Producer);

Task Con = new Task(Consumer);

// Запустить задачи.

Con.Start();

Prod.Start();

// Ожидать завершения обеих задач,

try {

Task.WaitAll(Con, Prod);

} catch(AggregateException exc) {

Console.WriteLine (exc);

} finally {

Con.Dispose();

Prod.Dispose();

bc.Dispose();

}

}

}

Если запустить эту программу на выполнение, то на экране появится смешанный результат, выводимый поставщиком и потребителем. Отчасти это объясняется тем, что коллекция bс ограничена 4 элементами, а это означает, что в нее может быть добавлено только четыре элемента, прежде чем ее придется сократить. В качестве эксперимента попробуйте сделать коллекцию bс неограниченной и понаблюдайте за полученными результатами. В некоторых средах выполнения это приведет к тому, что все элементы коллекции будут сформированы до того, как начнется какое-либо их потребление. Кроме того, попробуйте ограничить коллекцию одним элементом. В этом случае одновременно может быть сформирован лишь один элемент.

Для работы с коллекцией типа BlockingCollectionможет оказаться полезным и метод CompleteAdding(). Ниже приведена форма его объявления.

public void CompleteAdding()

Вызов этого метода означает, что в коллекцию не будет больше добавлено ни одного элемента. Это приводит к тому, что свойство IsAddingCompleteпринимает логическое значение true. Если же коллекция пуста, то свойство IsCompletedпринимает логическое значение true, и в этом случае вызовы метода Таке()не блокируются. Ниже приведены формы объявления свойств IsAddingCompleteи IsCompleted.

public bool IsCompleted { get; }

public bool IsAddingComplete { get; }

Когда коллекция типа BlockingCollectionтолько начинает формироваться, эти свойства содержат логическое значение false. А после вызова метода CompleteAdding()они принимают логическое значение true.