Integrate a Queue with an ObjectPool

[Craig Buchanan]

I would like to have a limited pool of objects (the objects are expensive to
create) that can be enlisted to process items in a queue. Moreover, I
would like to be able to have the processing (time-consuming) occur on a
background thread.

I have two questions:
* what is a good way to block the queue loop while it waits for a free
worker?
* is my approach a reasonable one?

Thanks,

Craig Buchanan

Here's my psedo-code:

Sub ProcessQueue

Do While Queue.Count 0

'wait for next available worker
Worker = ObjectPool.getFreeWorker()

'assign next item in the queue to the worker
Worker.Item = Queue.Dequeue

'run time-consuming process in background
ThreadPool.QueueUserWorkItem(AddressOf ProcessItem, Worker)

Loop

End Sub

Sub ProcessItem(State As Object)

Dim WorkerAs Worker= CType(State,Worker)

Try

'process item
Worker.Process()

Catch ex As Exception

'return item to queue
Queue.Enqueue(Worker.Item)

Finally

'return worker to pool
ObjectPool.returnWorker(Worker)

End Try

End Sub

[Chris Mullins [MVP]]

I've written this code more times than I can count, so I hope it's a decent
pattern to follow.

One of these days soon, I'll post my ObjectPool<Tclasses to my blog, along
with some instructions on how to use them. This problem seems to come up
very frequently when writing server applications - we've got dozens of
"expensive" object pools that we maintain. Everything from AD & LDAP
connections, to pinned byte[] buffers for use in reading & writing to
Sockets (to avoid heap fragmentation).

It's got a nice robust mechanism for checking objects in & out of the pool
(using IDisposable so that 'using' blocks can be employed, and also using
Object Resurrection so that the Finalizer is run, the expensive object
doesn't get lost) and its very easy to use.

You wait problem, as you've described it, I usually see it solved with the
Monitor.Pulse / PulseAll pattern. Worker threads are kept blocked in a
Monitor, and when data is added to the queue, the Monitor is Pulsed
realeasing one of the waiting threads. You've got to be carefull of race
conditions, but it's a very well worn pattern.

--
Chris Mullins, MCSD.NET, MCPD:Enterprise, Microsoft C# MVP
http://www.coversant.com/blogs/cmullins

"Craig Buchanan" <so*****@somewhere.comwrote in message
news:%2****************@TK2MSFTNGP03.phx.gbl...

>I would like to have a limited pool of objects (the objects are expensive
to create) that can be enlisted to process items in a queue. Moreover, I
would like to be able to have the processing (time-consuming) occur on a
background thread.

I have two questions:
* what is a good way to block the queue loop while it waits for a free
worker?
* is my approach a reasonable one?

Thanks,

Craig Buchanan

Here's my psedo-code:

Sub ProcessQueue

Do While Queue.Count 0

'wait for next available worker
Worker = ObjectPool.getFreeWorker()

'assign next item in the queue to the worker
Worker.Item = Queue.Dequeue

'run time-consuming process in background
ThreadPool.QueueUserWorkItem(AddressOf ProcessItem, Worker)

Loop

End Sub

Sub ProcessItem(State As Object)

Dim WorkerAs Worker= CType(State,Worker)

Try

'process item
Worker.Process()

Catch ex As Exception

'return item to queue
Queue.Enqueue(Worker.Item)

Finally

'return worker to pool
ObjectPool.returnWorker(Worker)

End Try

End Sub

[Craig Buchanan]

Chris-

Thanks for the reply. Does your approach also use the ThreadPool to process
the long-running job?

Any chance I could see the code? craig dot buchanan at cogniza dot com. is
this your blog: http://instructors.cwrl.utexas.edu/jesson/?q=blog/61 ?

Thanks,

Craig

"Chris Mullins [MVP]" <cm******@yahoo.comwrote in message
news:es****************@TK2MSFTNGP03.phx.gbl...

I've written this code more times than I can count, so I hope it's a
decent pattern to follow.

One of these days soon, I'll post my ObjectPool<Tclasses to my blog,
along with some instructions on how to use them. This problem seems to
come up very frequently when writing server applications - we've got
dozens of "expensive" object pools that we maintain. Everything from AD &
LDAP connections, to pinned byte[] buffers for use in reading & writing to
Sockets (to avoid heap fragmentation).

It's got a nice robust mechanism for checking objects in & out of the pool
(using IDisposable so that 'using' blocks can be employed, and also using
Object Resurrection so that the Finalizer is run, the expensive object
doesn't get lost) and its very easy to use.

You wait problem, as you've described it, I usually see it solved with the
Monitor.Pulse / PulseAll pattern. Worker threads are kept blocked in a
Monitor, and when data is added to the queue, the Monitor is Pulsed
realeasing one of the waiting threads. You've got to be carefull of race
conditions, but it's a very well worn pattern.

--
Chris Mullins, MCSD.NET, MCPD:Enterprise, Microsoft C# MVP
http://www.coversant.com/blogs/cmullins

"Craig Buchanan" <so*****@somewhere.comwrote in message
news:%2****************@TK2MSFTNGP03.phx.gbl...

>>I would like to have a limited pool of objects (the objects are expensive
to create) that can be enlisted to process items in a queue. Moreover, I
would like to be able to have the processing (time-consuming) occur on a
background thread.

I have two questions:
* what is a good way to block the queue loop while it waits for a free
worker?
* is my approach a reasonable one?

Thanks,

Craig Buchanan

Here's my psedo-code:

Sub ProcessQueue

Do While Queue.Count 0

'wait for next available worker
Worker = ObjectPool.getFreeWorker()

'assign next item in the queue to the worker
Worker.Item = Queue.Dequeue

'run time-consuming process in background
ThreadPool.QueueUserWorkItem(AddressOf ProcessItem, Worker)

Loop

End Sub

Sub ProcessItem(State As Object)

Dim WorkerAs Worker= CType(State,Worker)

Try

'process item
Worker.Process()

Catch ex As Exception

'return item to queue
Queue.Enqueue(Worker.Item)

Finally

'return worker to pool
ObjectPool.returnWorker(Worker)

End Try

End Sub

[Craig Buchanan]

Chris-

I'm wondering if it would make sense for the ObjectPool to drive the process
of 'draining' the queue. Think of how bank tellers process a line of
customers.

Perhaps there would be an event (or delegate) that would fire when an item
in the pool becomes free. in the event's code, the worker would grab the
next time in the queue.

Seems like there would need to be a method on the ObjectPool to signal this
process to begin. Perhaps it could listen to an event raised by
queue.enqueue().

Thoughts?

"Chris Mullins [MVP]" <cm******@yahoo.comwrote in message
news:es****************@TK2MSFTNGP03.phx.gbl...

I've written this code more times than I can count, so I hope it's a
decent pattern to follow.

One of these days soon, I'll post my ObjectPool<Tclasses to my blog,
along with some instructions on how to use them. This problem seems to
come up very frequently when writing server applications - we've got
dozens of "expensive" object pools that we maintain. Everything from AD &
LDAP connections, to pinned byte[] buffers for use in reading & writing to
Sockets (to avoid heap fragmentation).

It's got a nice robust mechanism for checking objects in & out of the pool
(using IDisposable so that 'using' blocks can be employed, and also using
Object Resurrection so that the Finalizer is run, the expensive object
doesn't get lost) and its very easy to use.

You wait problem, as you've described it, I usually see it solved with the
Monitor.Pulse / PulseAll pattern. Worker threads are kept blocked in a
Monitor, and when data is added to the queue, the Monitor is Pulsed
realeasing one of the waiting threads. You've got to be carefull of race
conditions, but it's a very well worn pattern.

--
Chris Mullins, MCSD.NET, MCPD:Enterprise, Microsoft C# MVP
http://www.coversant.com/blogs/cmullins

"Craig Buchanan" <so*****@somewhere.comwrote in message
news:%2****************@TK2MSFTNGP03.phx.gbl...

>>I would like to have a limited pool of objects (the objects are expensive
to create) that can be enlisted to process items in a queue. Moreover, I
would like to be able to have the processing (time-consuming) occur on a
background thread.

I have two questions:
* what is a good way to block the queue loop while it waits for a free
worker?
* is my approach a reasonable one?

Thanks,

Craig Buchanan

Here's my psedo-code:

Sub ProcessQueue

Do While Queue.Count 0

'wait for next available worker
Worker = ObjectPool.getFreeWorker()

'assign next item in the queue to the worker
Worker.Item = Queue.Dequeue

'run time-consuming process in background
ThreadPool.QueueUserWorkItem(AddressOf ProcessItem, Worker)

Loop

End Sub

Sub ProcessItem(State As Object)

Dim WorkerAs Worker= CType(State,Worker)

Try

'process item
Worker.Process()

Catch ex As Exception

'return item to queue
Queue.Enqueue(Worker.Item)

Finally

'return worker to pool
ObjectPool.returnWorker(Worker)

End Try

End Sub

[Brian Gideon]

On Mar 27, 3:37 pm, "Craig Buchanan" <[e-mail]:

I would like to have a limited pool of objects (the objects are expensive to
create) that can be enlisted to process items in a queue. Moreover, I
would like to be able to have the processing (time-consuming) occur on a
background thread.

I have two questions:
* what is a good way to block the queue loop while it waits for a free
worker?

The best way to block the loop is to block the getFreeWorker method
until a free worker is available. The pattern you're looking for is a
producer-consumer queue or blocking queue. Look for the
ProducerConsumer class in the following article. The Produce and
Consume methods in that class would map directly to your returnWorker
and getFreeWorker methods respectively. I know the examples in the
article are in C#, but you'll get the idea.

http://www.yoda.arachsys.com/csharp/...eadlocks.shtml

* is my approach a reasonable one?

Yes, I think it is reasonable. There might be some minor changes I
would change regarding your general pattern, but nothing worth
mentioning.

Thanks,

Craig Buchanan

Here's my psedo-code:

Sub ProcessQueue

Do While Queue.Count 0

'wait for next available worker
Worker = ObjectPool.getFreeWorker()

'assign next item in the queue to the worker
Worker.Item = Queue.Dequeue

'run time-consuming process in background
ThreadPool.QueueUserWorkItem(AddressOf ProcessItem, Worker)

Loop

End Sub

Sub ProcessItem(State As Object)

Dim WorkerAs Worker= CType(State,Worker)

Try

'process item
Worker.Process()

Catch ex As Exception

'return item to queue
Queue.Enqueue(Worker.Item)

Finally

'return worker to pool
ObjectPool.returnWorker(Worker)

End Try

End Sub

[Chris Mullins [MVP]]

"Craig Buchanan" <so*****@somewhere.comwrote:

is this your blog: http://instructors.cwrl.utexas.edu/jesson/?q=blog/61 ?

Nope, not my blog. I'll give ya a hint though: look at the bottom of this
message. The owner of that blog would probably cry if he was forced to ready
my poor writing all day long...

I'll post the ObjectPool<Tcode to my blog in a few days (when I write my
next entry).

Ping me if I forget...

--
Chris Mullins, MCSD.NET, MCPD:Enterprise, Microsoft C# MVP
http://www.coversant.com/blogs/cmullins

[Craig Buchanan]

Thanks for the help.

Craig

"Chris Mullins [MVP]" <cm******@yahoo.comwrote in message
news:uK****************@TK2MSFTNGP03.phx.gbl...

"Craig Buchanan" <so*****@somewhere.comwrote:

>is this your blog: http://instructors.cwrl.utexas.edu/jesson/?q=blog/61 ?

Nope, not my blog. I'll give ya a hint though: look at the bottom of this
message. The owner of that blog would probably cry if he was forced to
ready my poor writing all day long...

I'll post the ObjectPool<Tcode to my blog in a few days (when I write my
next entry).

Ping me if I forget...

--
Chris Mullins, MCSD.NET, MCPD:Enterprise, Microsoft C# MVP
http://www.coversant.com/blogs/cmullins

[Chris Mullins [MVP]]

"Craig Buchanan" <so*****@somewhere.comwrote in message

Thanks for the reply. Does your approach also use the ThreadPool to
process the long-running job?

No, it doesn't. You shouldn't use the ThreadPool for long running jobs.
It'll cause all sorts of issues and problems.

http://www.coversant.com/dotnetnuke/...d=88&EntryID=8

--
Chris Mullins, MCSD.NET, MCPD:Enterprise, Microsoft C# MVP
http://www.coversant.com/blogs/cmullins

[Craig Buchanan]

Brian-

That's pretty slick. It makes a lot of sense too.

Here's an example of a blocking queue:
http://www.codeproject.com/csharp/bo...ckingqueue.asp

Thanks for the reply,

Craig

"Brian Gideon" <br*********@yahoo.comwrote in message
news:11*********************@y80g2000hsf.googlegro ups.com...

On Mar 27, 3:37 pm, "Craig Buchanan" <[e-mail]:

>I would like to have a limited pool of objects (the objects are expensive
to
create) that can be enlisted to process items in a queue. Moreover, I
would like to be able to have the processing (time-consuming) occur on a
background thread.

I have two questions:
* what is a good way to block the queue loop while it waits for a free
worker?

The best way to block the loop is to block the getFreeWorker method
until a free worker is available. The pattern you're looking for is a
producer-consumer queue or blocking queue. Look for the
ProducerConsumer class in the following article. The Produce and
Consume methods in that class would map directly to your returnWorker
and getFreeWorker methods respectively. I know the examples in the
article are in C#, but you'll get the idea.

http://www.yoda.arachsys.com/csharp/...eadlocks.shtml

>* is my approach a reasonable one?

Yes, I think it is reasonable. There might be some minor changes I
would change regarding your general pattern, but nothing worth
mentioning.

>Thanks,

Craig Buchanan

Here's my psedo-code:

Sub ProcessQueue

Do While Queue.Count 0

'wait for next available worker
Worker = ObjectPool.getFreeWorker()

'assign next item in the queue to the worker
Worker.Item = Queue.Dequeue

'run time-consuming process in background
ThreadPool.QueueUserWorkItem(AddressOf ProcessItem, Worker)

Loop

End Sub

Sub ProcessItem(State As Object)

Dim WorkerAs Worker= CType(State,Worker)

Try

'process item
Worker.Process()

Catch ex As Exception

'return item to queue
Queue.Enqueue(Worker.Item)

Finally

'return worker to pool
ObjectPool.returnWorker(Worker)

End Try

End Sub

[Craig Buchanan]

Chris-

Are you still planning to add this to your blog?

Thanks,

Craig

"Chris Mullins [MVP]" <cm******@yahoo.comwrote in message
news:uK****************@TK2MSFTNGP03.phx.gbl...

"Craig Buchanan" <so*****@somewhere.comwrote:

>is this your blog: http://instructors.cwrl.utexas.edu/jesson/?q=blog/61 ?

Nope, not my blog. I'll give ya a hint though: look at the bottom of this
message. The owner of that blog would probably cry if he was forced to
ready my poor writing all day long...

I'll post the ObjectPool<Tcode to my blog in a few days (when I write my
next entry).

Ping me if I forget...

--
Chris Mullins, MCSD.NET, MCPD:Enterprise, Microsoft C# MVP
http://www.coversant.com/blogs/cmullins

[Chris Mullins [MVP]]

"Chris Mullins [MVP]" <cm******@yahoo.comwrote in message:

One of these days soon, I'll post my ObjectPool<Tclasses to my blog,
along with some instructions on how to use them.

I finally wrote up my ObjectPool<Tclass, and posted it to my Blog.

http://www.coversant.com/Default.asp...=88&EntryID=36

Lemme know how ya like it...

--
Chris Mullins, MCSD.NET, MCPD:Enterprise, Microsoft C# MVP
http://www.coversant.com/blogs/cmullins