From 8b01da9271db0cf53e1e701857563111025eadc2 Mon Sep 17 00:00:00 2001 From: Sean C Foley Date: Mon, 17 Oct 2016 04:03:21 -0400 Subject: [PATCH] Update README.md --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 27d1e7a..41bf4dd 100644 --- a/README.md +++ b/README.md @@ -10,10 +10,14 @@ High performance C++ implementation of producer/consumer queue architecture * designed to be fast * easy to customize to enqueue any data types. +##Source folders + +For the queues themselves, all you need is the base and queue source folders, as well as the threading folder which contains basic wrappers for mutexes and conditional variables. The consumer folder is optional, containing code to maintain a set of queue consumer worker threads, also requiring the thread wrapper class in the threading source folder. Finally, the sample folder is sample code showing how to pull it all together. + ## Sample code See the [sample](https://github.com/seancfoley/High-Performance-CPP-Queues/tree/master/ProcessingQueues/src/sample) folder for an implementation using two data types that can be enqueued (SampleQueueEntry1 and 2), and some test code which starts up writer threads, a queue processor engine with multiple readers, a single consumer class SampleQueueEntryConsumer used by the queue consumer threads, and adds numerous entries to the queue for consumption in testQueues. The sample code makes use of the [consumer folder](https://github.com/seancfoley/High-Performance-CPP-Queues/tree/master/ProcessingQueues/src/consumer), which includes a QueueProcessor engine which contains a queue (by default multi-reader and multi-writer) and also manages a set of consumer threads to pull entries off the queue. -For the queues themselves, all you need is the base and queue source folders. The consumer folder is optional, containing code to maintain a set of queue consumer worker threads, requiring the basic wrapper classes in the threading source folder. Finally, the sample folder shows how to pull it all together. + ### Platforms * Written in portable code for all platforms