{"id":55922,"date":"2010-04-13T10:00:00","date_gmt":"2010-04-13T10:00:00","guid":{"rendered":"https:\/\/blogs.msdn.microsoft.com\/pfxteam\/2010\/04\/13\/parallelextensionsextras-tour-9-objectpoolt\/"},"modified":"2010-04-13T10:00:00","modified_gmt":"2010-04-13T10:00:00","slug":"parallelextensionsextras-tour-9-objectpoolt","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/dotnet\/parallelextensionsextras-tour-9-objectpoolt\/","title":{"rendered":"ParallelExtensionsExtras Tour – #9 – ObjectPool"},"content":{"rendered":"

(The full set of ParallelExtensionsExtras Tour posts is available <\/em>here<\/em><\/font><\/a>.)<\/em> <\/font><\/font><\/p>\n

An object pool is a mechanism\/pattern to avoid the repeated creation and destruction of objects.  <\/span>When code is done with an object, rather than allowing it to be garbage collected (and finalized if it’s finalizable), you put the object back into a special collection known as an object pool.  <\/span>Then, when you need an object, rather than always creating one, you ask the pool for one: if it has one, it gives it to you, otherwise it creates one and gives it to you.  <\/span>In many situations where creation and destruction is expensive, and where many objects are needed but where only a few at a time are needed, this can result in significant performance gains.<\/p>\n

<\/font><\/font><\/p>\n

Object pools are just as relevant in multi-threaded scenarios as they are in single-threaded scenarios, but of course when dealing with multiple threads, you need to synchronize correctly (unless a separate pool is maintained per thread, in which case you’re trading synchronization cost for potentially creating more objects than you otherwise would).  <\/span>ParallelExtensionsExtras<\/a> contains a simple ObjectPool<T> implementation in the ObjectPool.cs file, built on top of IProducerConsumerCollection<T>.<\/p>\n

<\/font><\/font><\/p>\n

The implementation in ParallelExtensionsExtras is slightly more complex than what we’ll show here, which is just the basic essence of the type (the implementation in ParallelExtensionsExtras also implements IProducerConsumerCollection<T> and provides some useful additional helper methods).<\/p>\n

<\/font><\/font><\/p>\n

public sealed class ObjectPool<T><\/p>\n

<\/font><\/p>\n

{<\/p>\n

<\/font><\/p>\n

    <\/span>private readonly Func<T> _generator;<\/p>\n

<\/font><\/p>\n

    <\/span>private readonly IProducerConsumerCollection<T> _objects;<\/p>\n

<\/font><\/p>\n

\n

 <\/font><\/p>\n<\/p>\n

    <\/span>public ObjectPool(Func<T> generator) : <\/p>\n

<\/font><\/p>\n

        <\/span>this(generator, new ConcurrentQueue<T>()) { }<\/p>\n

<\/font><\/p>\n

\n

 <\/font><\/p>\n<\/p>\n

    <\/span>public ObjectPool(Func<T> generator, <\/p>\n

<\/font><\/p>\n

        <\/span>IProducerConsumerCollection<T> collection)<\/p>\n

<\/font><\/p>\n

    <\/span>{<\/p>\n

<\/font><\/p>\n

        <\/span>if (generator == null) <\/font><\/p>\n

            throw new ArgumentNullException(“generator”);<\/p>\n

<\/font><\/p>\n

        <\/span>if (collection == null) <\/font><\/p>\n

            throw new ArgumentNullException(“collection”);<\/p>\n

<\/font><\/p>\n

        <\/span>_generator = generator;<\/p>\n

<\/font><\/p>\n

        <\/span>_collection = collection;<\/p>\n

<\/font><\/p>\n

   <\/span> <\/span>}<\/p>\n

<\/font><\/p>\n

\n

 <\/font><\/p>\n<\/p>\n

    <\/span>public void PutObject(T item) { _objects.TryAdd(item); }<\/p>\n

<\/font><\/p>\n

\n

 <\/font><\/p>\n<\/p>\n

    <\/span>public T GetObject()<\/p>\n

<\/font><\/p>\n

    <\/span>{<\/p>\n

<\/font><\/p>\n

        <\/span>T value;<\/p>\n

<\/font><\/p>\n

        <\/span>return _objects.TryTake(out value) ? value : _generator();<\/p>\n

<\/font><\/p>\n

    <\/span>}<\/p>\n

<\/font><\/p>\n

}<\/p>\n

<\/font><\/p>\n

\n

 <\/font><\/p>\n<\/p>\n

The constructors initialize the pool with the generator function to use for creating objects when the pool is empty as well as a collection used to store all of the pooled objects.  <\/span>The PutObject method simply adds the object into the collection. The GetObject method tries to take an object from the collection and return it, returning a newly generated object instead if nothing could be retrieved from the collection.<\/p>\n

<\/font><\/font><\/p>\n

Note that an instance of this ObjectPool<T> type may be used from multiple threads concurrently, and all of the synchronization is handled automatically by the IProducerConsumerCollection<T> implementation.<\/p>\n

<\/font><\/font><\/p><\/p>\n","protected":false},"excerpt":{"rendered":"

(The full set of ParallelExtensionsExtras Tour posts is available here.)  An object pool is a mechanism\/pattern to avoid the repeated creation and destruction of objects.  When code is done with an object, rather than allowing it to be garbage collected (and finalized if it’s finalizable), you put the object back into a special collection known as an […]<\/p>\n","protected":false},"author":360,"featured_media":58792,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[7908],"tags":[7907,7911,7916,7909,7924],"class_list":["post-55922","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-pfxteam","tag-net-4","tag-code-samples","tag-coordination-data-structures","tag-parallel-extensions","tag-parallelextensionsextras"],"acf":[],"blog_post_summary":"

(The full set of ParallelExtensionsExtras Tour posts is available here.)  An object pool is a mechanism\/pattern to avoid the repeated creation and destruction of objects.  When code is done with an object, rather than allowing it to be garbage collected (and finalized if it’s finalizable), you put the object back into a special collection known as an […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/posts\/55922","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/users\/360"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/comments?post=55922"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/posts\/55922\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/media\/58792"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/media?parent=55922"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/categories?post=55922"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/tags?post=55922"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}