• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * libjingle
3  * Copyright 2004--2006, Google Inc.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  *  1. Redistributions of source code must retain the above copyright notice,
9  *     this list of conditions and the following disclaimer.
10  *  2. Redistributions in binary form must reproduce the above copyright notice,
11  *     this list of conditions and the following disclaimer in the documentation
12  *     and/or other materials provided with the distribution.
13  *  3. The name of the author may not be used to endorse or promote products
14  *     derived from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
17  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
18  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
19  * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
25  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 #ifndef TALK_BASE_TASKPARENT_H__
29 #define TALK_BASE_TASKPARENT_H__
30 
31 #include <set>
32 
33 #include "talk/base/basictypes.h"
34 #include "talk/base/scoped_ptr.h"
35 
36 namespace talk_base {
37 
38 class Task;
39 class TaskRunner;
40 
41 class TaskParent {
42  public:
43   TaskParent(Task *derived_instance, TaskParent *parent);
44   explicit TaskParent(TaskRunner *derived_instance);
~TaskParent()45   virtual ~TaskParent() { }
46 
GetParent()47   TaskParent *GetParent() { return parent_; }
GetRunner()48   TaskRunner *GetRunner() { return runner_; }
49 
50   // Retrieves a parent that corresponds to the given "code".  The code
51   // should be defined in a unique manner for the given subtree.  This
52   // method will crash (when the parent_ is NULL) if there is no corresponding
53   // parent.
54   //
55   // Example use:
56   //  XmppClient* client =
57   //      static_cast<XmppClient*>(parent->GetParent(XMPP_CLIENT_TASK_CODE));
GetParent(int code)58   virtual TaskParent *GetParent(int code) { return parent_->GetParent(code); }
59 
60   bool AllChildrenDone();
61   bool AnyChildError();
62 #ifdef _DEBUG
63   bool IsChildTask(Task *task);
64 #endif
65 
66  protected:
67   void OnStopped(Task *task);
68   void AbortAllChildren();
parent()69   TaskParent *parent() {
70     return parent_;
71   }
72 
73  private:
74   void Initialize();
75   void OnChildStopped(Task *child);
76   void AddChild(Task *child);
77 
78   TaskParent *parent_;
79   TaskRunner *runner_;
80   bool child_error_;
81   typedef std::set<Task *> ChildSet;
82   scoped_ptr<ChildSet> children_;
83   DISALLOW_EVIL_CONSTRUCTORS(TaskParent);
84 };
85 
86 
87 } // namespace talk_base
88 
89 #endif  // TALK_BASE_TASKPARENT_H__
90