[asterisk-scf-commits] asterisk-scf/integration/util-cpp.git branch "master" created.
Commits to the Asterisk SCF project code repositories
asterisk-scf-commits at lists.digium.com
Thu Jan 20 18:02:23 CST 2011
branch "master" has been created
at 1b563f1e9fd043ac81420abe580454cda567c3cf (commit)
- Log -----------------------------------------------------------------
commit 1b563f1e9fd043ac81420abe580454cda567c3cf
Author: unknown <Ken Hunt at .(none)>
Date: Thu Jan 20 17:58:56 2011 -0600
Initial migration of WorkQueue into util-cpp.
diff --git a/CMakeLists.txt b/CMakeLists.txt
new file mode 100644
index 0000000..2a28ed3
--- /dev/null
+++ b/CMakeLists.txt
@@ -0,0 +1,6 @@
+if (integrated_build STREQUAL "true")
+ set(util_cpp_dir ${CMAKE_CURRENT_SOURCE_DIR} PARENT_SCOPE)
+ set(util_cpp_bindir ${CMAKE_CURRENT_BINARY_DIR} PARENT_SCOPE)
+endif()
+
+add_subdirectory(WorkQueue)
diff --git a/COPYING.txt b/COPYING.txt
new file mode 100644
index 0000000..cf87abb
--- /dev/null
+++ b/COPYING.txt
@@ -0,0 +1,340 @@
+
+ GNU GENERAL PUBLIC LICENSE
+ Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+ 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it. (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.) You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+ To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. You must make sure that they, too, receive or can get the
+source code. And you must show them these terms so they know their
+rights.
+
+ We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+ Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+ Finally, any free program is threatened constantly by software
+patents. We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary. To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ GNU GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License. The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language. (Hereinafter, translation is included without limitation in
+the term "modification".) Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+ 1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+ 2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in
+ whole or in part contains or is derived from the Program or any
+ part thereof, to be licensed as a whole at no charge to all third
+ parties under the terms of this License.
+
+ c) If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such
+ interactive use in the most ordinary way, to print or display an
+ announcement including an appropriate copyright notice and a
+ notice that there is no warranty (or else, saying that you provide
+ a warranty) and that users may redistribute the program under
+ these conditions, and telling the user how to view a copy of this
+ License. (Exception: if the Program itself is interactive but
+ does not normally print such an announcement, your work based on
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of Sections
+ 1 and 2 above on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your
+ cost of physically performing source distribution, a complete
+ machine-readable copy of the corresponding source code, to be
+ distributed under the terms of Sections 1 and 2 above on a medium
+ customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer
+ to distribute corresponding source code. (This alternative is
+ allowed only for noncommercial distribution and only if you
+ received the program in object code or executable form with such
+ an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it. For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable. However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+ 4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+ 5. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Program or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+ 6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+ 7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all. For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+ 8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded. In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+ 9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation. If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+ 10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission. For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this. Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+ NO WARRANTY
+
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) 19yy <name of author>
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, write to the Free Software
+ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) 19yy name of author
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+ <signature of Ty Coon>, 1 April 1989
+ Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs. If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library. If this is what you want to do, use the GNU Library General
+Public License instead of this License.
diff --git a/LICENSE.txt b/LICENSE.txt
new file mode 100644
index 0000000..ff0499c
--- /dev/null
+++ b/LICENSE.txt
@@ -0,0 +1,84 @@
+Asterisk SCF is distributed by Digium, Inc. (Digium) under the GNU
+General Public License version 2 (GPLv2) and is also available under
+alternative licenses negotiated directly with Digium. If you obtained
+Asterisk SCF under the GPLv2, then those terms apply to all programs
+you distribute that communicate using the Asterisk SCF object
+interfaces (APIs) on objects provided by Asterisk SCF's components, as
+defined below. A copy of the GPLv2 is included in the Asterisk SCF
+source tree in the file COPYING.txt.
+
+Asterisk SCF is a collection of programs that communicate with each
+other over defined APIs. This communication can occur within a single
+process (if two programs are loaded into a suitable container),
+between processes on a single machine, between processes on different
+machines, or some combination. In addition, these APIs are usable
+across a number of platforms and also across a variety of programming
+languages, many of which are interpreted (scripting)
+languages. Because of this flexibility and the possible ambiguity in
+interpretation of the provisions of the GPLv2 as they apply to
+Asterisk SCF, Digium makes the following statement:
+
+ It is Digium's interpretation that because the Asterisk SCF APIs,
+ by definition, expose direct, and indirect, complex remote, and
+ non-remote, function calls on objects provided by Asterisk SCF's
+ programs, that usage of these APIs between the program hosting the
+ object(s) and the program accessing the object(s) creates a
+ derivative work that must be covered wholly by GPLv2, even if the
+ mechanism used to invoke the function calls employs a
+ cross-process or network connection. As a result, any program that
+ employs the Asterisk SCF APIs to perform its intended functions,
+ and would not be able to perform those intended functions without
+ using these APIs to communicate with Asterisk SCF programs, or
+ derivatives of Asterisk SCF programs, is subject to the terms of
+ the GPLv2 when it is distributed, unless the distributor of the
+ program has obtained explicit written permission from Digium to
+ distribute it under a different license.
+
+Digium is able to grant, at its sole discretion, permission for
+companies, individuals or organizations to distribute programs that
+use the Asterisk SCF APIs under open source or proprietary
+terms. Digium is able to do this because all components of the
+Asterisk SCF package are either copyrighted by Digium, because Digium
+has been granted a sufficient license by the component's copyright
+holder(s), or some combination thereof.
+
+Digium grants specific permission for anyone to distribute programs
+that use the Asterisk SCF APIs and also use the OpenSSL toolkit, Ice
+(Internet Communication Engine) from ZeroC and/or the UW IMAP toolkit
+("Open Source Exceptions"), even though the terms of the GPLv2 do not
+allow such distribution. This permission only extends to distributions
+that properly acknowledge and comply with the terms of the licenses on
+the Open Source Exceptions that are used in addition to the terms of
+the GPLv2.
+
+If you wish to use Asterisk SCF code in other GPLv2 programs, there is
+no requirement that you provide the same permissions for these Open
+Source Exceptions to recipients of your programs (although if you have
+written a program for Asterisk SCF, Digium would strongly encourage
+you to grant the same permissions granted by Digium).
+
+The 'Ice' and 'ZeroC' names are trademarks of ZeroC, Inc.
+
+The "Asterisk SCF" name and logos are trademarks owned by Digium and
+use of them is subject to Digium's trademark licensing policies. If
+you wish to use these trademarks for purposes other than unmodified
+redistribution of Asterisk SCF source code obtained from Digium, you
+should contact Digium's licensing department to determine the
+necessary steps you must take. For more information on this policy,
+please read:
+
+http://www.digium.com/en/company/profile/trademarkpolicy.php
+
+If you have any questions regarding our licensing policy, please contact us:
+
++1.877.344.4861 (via telephone in the USA)
++1.256.428.6000 (via telephone outside the USA)
++1.256.864.0464 (via FAX inside or outside the USA)
+IAX2/pbx.digium.com (via IAX2)
+sip:6000 at digium.com (via SIP)
+licensing at digium.com (via email)
+
+Digium, Inc.
+445 Jan Davis Drive NW
+Huntsville, AL 35806
+USA
diff --git a/WorkQueue/CMakeLists.txt b/WorkQueue/CMakeLists.txt
new file mode 100644
index 0000000..d4f5412
--- /dev/null
+++ b/WorkQueue/CMakeLists.txt
@@ -0,0 +1,31 @@
+#
+# Asterisk Scalable Communications Framework
+#
+# Copyright (C) 2010, 2011 -- Digium, Inc.
+#
+# All rights reserved.
+#
+
+asterisk_scf_component_init(WorkQueue CXX)
+
+include_directories(include)
+
+asterisk_scf_component_add_slice(WorkQueue LoggerIf)
+asterisk_scf_component_add_file(WorkQueue include/AsteriskSCF/WorkQueue/WorkQueue.h)
+asterisk_scf_component_add_file(WorkQueue include/AsteriskSCF/WorkQueue/SimpleWorkQueue.h)
+asterisk_scf_component_add_file(WorkQueue src/SimpleWorkQueue.cpp)
+asterisk_scf_component_add_boost_libraries(WorkQueue core thread)
+
+if(NOT logger_dir)
+ message(FATAL_ERROR "The logger directory could not be found ${logger_dir}")
+endif()
+
+include_directories(${logger_dir}/common)
+include_directories(${logger_dir}/client/src)
+
+asterisk_scf_component_build_library(WorkQueue)
+
+target_link_libraries(WorkQueue logging-client)
+
+asterisk_scf_component_install(WorkQueue LIBRARY lib "Work Queue" WorkQueue ARCHIVE DESTINATION lib)
+
diff --git a/WorkQueue/include/AsteriskSCF/WorkQueue/SimpleWorkQueue.h b/WorkQueue/include/AsteriskSCF/WorkQueue/SimpleWorkQueue.h
new file mode 100644
index 0000000..d597271
--- /dev/null
+++ b/WorkQueue/include/AsteriskSCF/WorkQueue/SimpleWorkQueue.h
@@ -0,0 +1,56 @@
+/*
+ * Asterisk SCF -- An open-source communications framework.
+ *
+ * Copyright (C) 2010, Digium, Inc.
+ *
+ * See http://www.asterisk.org for more information about
+ * the Asterisk SCF project. Please do not directly contact
+ * any of the maintainers of this project for assistance;
+ * the project provides a web site, mailing lists and IRC
+ * channels for your use.
+ *
+ * This program is free software, distributed under the terms of
+ * the GNU General Public License Version 2. See the LICENSE.txt file
+ * at the top of the source tree.
+ */
+#pragma once
+
+#include <list>
+#include <string>
+#include <boost/thread.hpp>
+#include <boost/thread/condition.hpp>
+#include <boost/shared_ptr.hpp>
+
+#include "WorkQueue.h"
+#include "logger.h"
+
+namespace AsteriskSCF
+{
+/**
+ * A simple Work Queue implementation.
+ * See WorkQueue for more information.
+ */
+class SimpleWorkQueuePriv;
+
+class ASTERISK_SCF_ICEBOX_EXPORT SimpleWorkQueue : public WorkQueue, boost::noncopyable
+{
+public:
+
+ SimpleWorkQueue(const std::string& id, const AsteriskSCF::System::Logging::Logger& logger);
+ ~SimpleWorkQueue();
+
+ virtual WorkQueue::PoolId enqueue(const WorkPtr& w);
+ virtual void terminate();
+ virtual void join();
+
+ // This implementation adds the concept of Pausing to the generic WorkQueue.
+ bool isRunning();
+ bool workPending();
+ void pause();
+ void resume();
+
+private:
+ boost::shared_ptr<SimpleWorkQueuePriv> mImpl;
+};
+
+};
diff --git a/WorkQueue/include/AsteriskSCF/WorkQueue/WorkQueue.h b/WorkQueue/include/AsteriskSCF/WorkQueue/WorkQueue.h
new file mode 100644
index 0000000..5b306cc
--- /dev/null
+++ b/WorkQueue/include/AsteriskSCF/WorkQueue/WorkQueue.h
@@ -0,0 +1,86 @@
+/*
+ * Asterisk SCF -- An open-source communications framework.
+ *
+ * Copyright (C) 2010, Digium, Inc.
+ *
+ * See http://www.asterisk.org for more information about
+ * the Asterisk SCF project. Please do not directly contact
+ * any of the maintainers of this project for assistance;
+ * the project provides a web site, mailing lists and IRC
+ * channels for your use.
+ *
+ * This program is free software, distributed under the terms of
+ * the GNU General Public License Version 2. See the LICENSE.txt file
+ * at the top of the source tree.
+ */
+#pragma once
+
+#include "boost/shared_ptr.hpp"
+
+namespace AsteriskSCF
+{
+/**
+ * This class defines an interface to a work queue. A work queue manages one or
+ * more processing threads, and allows work to be enqueued.
+ */
+class WorkQueue
+{
+public:
+
+ /**
+ * This is the interface for work that gets enqueued.
+ */
+ class Work
+ {
+ public:
+ virtual void doWork() = 0;
+ virtual ~Work() {};
+ };
+ typedef boost::shared_ptr<Work> WorkPtr;
+
+ /**
+ * Value used as a token to identify a particular thread.
+ * For implementations where this interface is
+ * in front of a Thread Pool implementation, this token can
+ * be used to direct future work for related items onto the same
+ * worker thread.
+ */
+ class PoolId
+ {
+ };
+
+ /**
+ * Enqueue work to be peformed.
+ */
+ virtual PoolId enqueue(const WorkPtr& w) = 0;
+
+ /**
+ * Enqueue work to be performed, and specify a particular thread
+ * of a Thread Pool to do the work.
+ * Note: Implementations of Thread Pools are expected to override this
+ * default implementation.
+ */
+ virtual void enqueue(const WorkPtr& w, PoolId)
+ {
+ enqueue(w);
+ }
+
+ /**
+ * Terminate the work queue.
+ */
+ virtual void terminate() = 0;
+
+ /**
+ * Block until processing on all worker threads completes.
+ */
+ virtual void join() = 0;
+
+ virtual ~WorkQueue() {};
+
+protected:
+ WorkQueue() {}; // Hide the constructor since this is an interface.
+};
+typedef WorkQueue::WorkPtr WorkPtr;
+
+};
+
diff --git a/WorkQueue/src/SimpleWorkQueue.cpp b/WorkQueue/src/SimpleWorkQueue.cpp
new file mode 100644
index 0000000..963d747
--- /dev/null
+++ b/WorkQueue/src/SimpleWorkQueue.cpp
@@ -0,0 +1,276 @@
+/*
+ * Asterisk SCF -- An open-source communications framework.
+ *
+ * Copyright (C) 2010, Digium, Inc.
+ *
+ * See http://www.asterisk.org for more information about
+ * the Asterisk SCF project. Please do not directly contact
+ * any of the maintainers of this project for assistance;
+ * the project provides a web site, mailing lists and IRC
+ * channels for your use.
+ *
+ * This program is free software, distributed under the terms of
+ * the GNU General Public License Version 2. See the LICENSE.txt file
+ * at the top of the source tree.
+ */
+
+/**
+ * A simple Work Queue implementation. On construction, starts an internal thread.
+ * Work can be enqueued via the thread-safe enqueue() method. All work must implement
+ * the Work interface.
+ */
+#include <iostream>
+#include <boost/shared_ptr.hpp>
+#include <boost/bind.hpp>
+#include <boost/thread.hpp>
+#include <list>
+
+#include "logger.h"
+
+#include "AsteriskSCF/WorkQueue/SimpleWorkQueue.h"
+
+using namespace AsteriskSCF;
+using namespace AsteriskSCF::System::Logging;
+using namespace boost;
+
+namespace // annonymous namespace has file-only visibility.
+{
+ /**
+ * This is a private no-op implementation of a work item. Returned from WaitAndDequeue
+ * if the program is Terminated while waiting on the EmptyQueueCondition.
+ */
+ class HiddenNoWorkClass : public WorkQueue::Work
+ {
+ public:
+ HiddenNoWorkClass() {};
+ void doWork() {} // Do nothing
+ };
+}
+
+namespace AsteriskSCF
+{
+class SimpleWorkQueuePriv
+{
+public:
+ SimpleWorkQueuePriv(const std::string& id, const Logger& logger)
+ : mLogger(logger),
+ mQid(id),
+ mInitialized(false),
+ mFinished(false),
+ mPaused(false), // runs by default.
+ mThread(boost::bind(&SimpleWorkQueuePriv::execute, this))
+
+ {
+ mLogger(Debug) << BOOST_CURRENT_FUNCTION << ": called. Queue ID:" << mQid;
+ }
+
+ ~SimpleWorkQueuePriv()
+ {
+ mLogger(Debug) << BOOST_CURRENT_FUNCTION << ": called. Queue ID:" << mQid;
+ }
+
+ WorkPtr dequeue();
+ WorkPtr waitAndDequeue();
+ void execute();
+ bool isPaused();
+
+ const Logger& mLogger;
+ std::string mQid;
+ bool mInitialized;
+ bool mFinished;
+ bool mPaused;
+ std::list<WorkPtr> mQueue;
+ boost::mutex mQueueMutex;
+ boost::condition mEmptyQueueCondition;
+ boost::mutex mPauseMutex;
+ boost::condition mPauseCondition;
+ boost::thread mThread; // This variable is last so that the class is fully initialized before the thread executes.
+};
+}
+
+SimpleWorkQueue::SimpleWorkQueue(const std::string& qid, const Logger& logger) : mImpl(new SimpleWorkQueuePriv(qid, logger))
+{
+ mImpl->mLogger(Debug) << BOOST_CURRENT_FUNCTION << ": called. Queue ID:" << mImpl->mQid;
+ mImpl->mInitialized = true;
+}
+
+SimpleWorkQueue::~SimpleWorkQueue()
+{
+ mImpl->mLogger(Debug) << BOOST_CURRENT_FUNCTION << ": called. Queue ID:" << mImpl->mQid;
+ terminate();
+
+ // Wait for worker thread to shut down.
+ join();
+}
+
+bool SimpleWorkQueue::isRunning()
+{
+ return (mImpl->mInitialized && !mImpl->mPaused && !mImpl->mFinished);
+}
+
+/**
+ * Pause the SimpleWorkQueue's thread.
+ */
+void SimpleWorkQueue::pause()
+{
+ mImpl->mLogger(Info) << BOOST_CURRENT_FUNCTION << ": called for queue " << mImpl->mQid;
+
+ boost::lock_guard<boost::mutex> lock(mImpl->mPauseMutex);
+ mImpl->mPaused = true;
+}
+
+/**
+ * Resume from a Paused state.
+ */
+void SimpleWorkQueue::resume()
+{
+ mImpl->mLogger(Info) << BOOST_CURRENT_FUNCTION << ": called for queue " << mImpl->mQid;
+
+ boost::lock_guard<boost::mutex> lock(mImpl->mPauseMutex);
+ mImpl->mPaused = false;
+ mImpl->mPauseCondition.notify_all();
+}
+
+/**
+ * Stops this thread from executing.
+ */
+void SimpleWorkQueue::terminate()
+{
+ mImpl->mLogger(Info) << BOOST_CURRENT_FUNCTION << ": called for queue " << mImpl->mQid ;
+
+ mImpl->mFinished = true;
+ mImpl->mPaused = false;
+
+ {
+ boost::lock_guard<boost::mutex> lock(mImpl->mPauseMutex);
+ mImpl->mPauseCondition.notify_all(); // In case the thread was waiting on the PauseCondition.
+ }
+
+ {
+ boost::lock_guard<boost::mutex> lock(mImpl->mQueueMutex);
+ mImpl->mEmptyQueueCondition.notify_all(); // In case the thread was waiting on an EmptyQueueCondition
+ }
+}
+
+/**
+ * A convenience method to determine if there is any pending work on the queue.
+ */
+bool SimpleWorkQueue::workPending()
+{
+ return !mImpl->mQueue.empty();
+}
+
+/**
+ * Allows other thread to join to this thread. The caller needs to
+ * call this object's Terminate method, or the join will block
+ * indefinitely.
+ */
+void SimpleWorkQueue::join()
+{
+ mImpl->mThread.join();
+}
+
+static WorkQueue::PoolId noOpPoolId;
+
+/**
+ * Enqueue an item of work for processing on this queue's thread.
+ */
+WorkQueue::PoolId SimpleWorkQueue::enqueue(const WorkPtr& w)
+{
+ bool wasEmpty(false);
+
+ { // scope for the mutex.
+ boost::lock_guard<boost::mutex> lock(mImpl->mQueueMutex);
+ wasEmpty = mImpl->mQueue.empty();
+ mImpl->mQueue.push_back(w);
+
+ if (wasEmpty)
+ {
+ mImpl->mEmptyQueueCondition.notify_all();
+ }
+ }
+
+ return noOpPoolId;
+}
+
+static shared_ptr<WorkQueue::Work> HiddenNoWorkPtr(new HiddenNoWorkClass());
+
+/**
+ * This method returns the next work from the queue. If no work available,
+ * this method waits on the EmptyQueueCondition.
+ */
+WorkPtr SimpleWorkQueuePriv::waitAndDequeue()
+{
+ boost::unique_lock<boost::mutex> lock(mQueueMutex);
+
+ while (mQueue.empty())
+ {
+ mLogger(Debug) << BOOST_CURRENT_FUNCTION << ": Waiting on empty queue. Queue ID:" << mQid;
+
+ if (mFinished)
+ {
+ mLogger(Info) << BOOST_CURRENT_FUNCTION << ": Returning the NO_WORK token. Queue ID:" << mQid;
+ return HiddenNoWorkPtr;
+ }
+
+ mEmptyQueueCondition.wait(lock);
+ }
+
+ mLogger(Debug) << BOOST_CURRENT_FUNCTION << ": Dequeuing some work. Queue ID:" << mQid;
+
+ shared_ptr<WorkQueue::Work> work = mQueue.front();
+ mQueue.pop_front();
+
+ return work;
+}
+
+bool SimpleWorkQueuePriv::isPaused()
+{
+ boost::lock_guard<boost::mutex> lock(mPauseMutex);
+ return mPaused;
+}
+
+/**
+ * This is the thread's event loop. The thread terminates when this method returns.
+ */
+void SimpleWorkQueuePriv::execute()
+{
+ while (!mFinished)
+ {
+ { // scope the lock
+ boost::unique_lock<boost::mutex> lock(mPauseMutex);
+ while(mPaused)
+ {
+ mLogger(Debug) << BOOST_CURRENT_FUNCTION << ": Waiting while paused. Queue ID:" << mQid;
+
+ mPauseCondition.wait(lock);
+ }
+
+ if (mFinished) // In case Terminate was called while in PauseCondition
+ {
+ break;
+ }
+ } // end lock scope
+
+ mLogger(Debug) << BOOST_CURRENT_FUNCTION << ": Pinging the work queue. Queue ID:" << mQid;
+
+ WorkPtr work = waitAndDequeue();
+
+ mLogger(Debug) << BOOST_CURRENT_FUNCTION << ": Doing the work. Queue ID:" << mQid;
+
+ try
+ {
+ work->doWork();
+ }
+ catch(const std::exception& e)
+ {
+ // Workers should be catching/managing their own exceptions!
+ mLogger(Warning) << BOOST_CURRENT_FUNCTION << ": Work item threw exception for queue " << mQid;
+ mLogger(Warning) << " Details: " << e.what();
+ }
+
+ } // while !mFinished
+
+ mLogger(Debug) << BOOST_CURRENT_FUNCTION << ": Exiting the thread for good. Queue ID:" << mQid;
+}
+
-----------------------------------------------------------------------
--
asterisk-scf/integration/util-cpp.git
More information about the asterisk-scf-commits
mailing list