Alex Deymo | aea4c1c | 2015-08-19 20:24:43 -0700 | [diff] [blame^] | 1 | // |
| 2 | // Copyright (C) 2011 The Android Open Source Project |
| 3 | // |
| 4 | // Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | // you may not use this file except in compliance with the License. |
| 6 | // You may obtain a copy of the License at |
| 7 | // |
| 8 | // http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | // |
| 10 | // Unless required by applicable law or agreed to in writing, software |
| 11 | // distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | // See the License for the specific language governing permissions and |
| 14 | // limitations under the License. |
| 15 | // |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 16 | |
Gilad Arnold | cf175a0 | 2014-07-10 16:48:47 -0700 | [diff] [blame] | 17 | #ifndef UPDATE_ENGINE_ACTION_PROCESSOR_H_ |
| 18 | #define UPDATE_ENGINE_ACTION_PROCESSOR_H_ |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 19 | |
| 20 | #include <deque> |
| 21 | |
Ben Chan | 05735a1 | 2014-09-03 07:48:22 -0700 | [diff] [blame] | 22 | #include <base/macros.h> |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 23 | |
David Zeuthen | a99981f | 2013-04-29 13:42:47 -0700 | [diff] [blame] | 24 | #include "update_engine/error_code.h" |
| 25 | |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 26 | // The structure of these classes (Action, ActionPipe, ActionProcessor, etc.) |
| 27 | // is based on the KSAction* classes from the Google Update Engine code at |
| 28 | // http://code.google.com/p/update-engine/ . The author of this file sends |
| 29 | // a big thanks to that team for their high quality design, implementation, |
| 30 | // and documentation. |
| 31 | |
Alex Vakulenko | 072359c | 2014-07-18 11:41:07 -0700 | [diff] [blame] | 32 | // See action.h for an overview of this class and other Action* classes. |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 33 | |
| 34 | // An ActionProcessor keeps a queue of Actions and processes them in order. |
| 35 | |
| 36 | namespace chromeos_update_engine { |
| 37 | |
| 38 | class AbstractAction; |
| 39 | class ActionProcessorDelegate; |
| 40 | |
| 41 | class ActionProcessor { |
| 42 | public: |
| 43 | ActionProcessor(); |
| 44 | |
Darin Petkov | f42cc1c | 2010-09-01 09:03:02 -0700 | [diff] [blame] | 45 | virtual ~ActionProcessor(); |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 46 | |
| 47 | // Starts processing the first Action in the queue. If there's a delegate, |
| 48 | // when all processing is complete, ProcessingDone() will be called on the |
| 49 | // delegate. |
Darin Petkov | f42cc1c | 2010-09-01 09:03:02 -0700 | [diff] [blame] | 50 | virtual void StartProcessing(); |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 51 | |
| 52 | // Aborts processing. If an Action is running, it will have |
| 53 | // TerminateProcessing() called on it. The Action that was running |
| 54 | // will be lost and must be re-enqueued if this Processor is to use it. |
| 55 | void StopProcessing(); |
| 56 | |
| 57 | // Returns true iff an Action is currently processing. |
Alex Vakulenko | 88b591f | 2014-08-28 16:48:57 -0700 | [diff] [blame] | 58 | bool IsRunning() const { return nullptr != current_action_; } |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 59 | |
| 60 | // Adds another Action to the end of the queue. |
Darin Petkov | f42cc1c | 2010-09-01 09:03:02 -0700 | [diff] [blame] | 61 | virtual void EnqueueAction(AbstractAction* action); |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 62 | |
Alex Vakulenko | 88b591f | 2014-08-28 16:48:57 -0700 | [diff] [blame] | 63 | // Sets/gets the current delegate. Set to null to remove a delegate. |
Darin Petkov | f42cc1c | 2010-09-01 09:03:02 -0700 | [diff] [blame] | 64 | ActionProcessorDelegate* delegate() const { return delegate_; } |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 65 | void set_delegate(ActionProcessorDelegate *delegate) { |
| 66 | delegate_ = delegate; |
| 67 | } |
| 68 | |
| 69 | // Returns a pointer to the current Action that's processing. |
| 70 | AbstractAction* current_action() const { |
| 71 | return current_action_; |
| 72 | } |
| 73 | |
| 74 | // Called by an action to notify processor that it's done. Caller passes self. |
David Zeuthen | a99981f | 2013-04-29 13:42:47 -0700 | [diff] [blame] | 75 | void ActionComplete(AbstractAction* actionptr, ErrorCode code); |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 76 | |
| 77 | private: |
| 78 | // Actions that have not yet begun processing, in the order in which |
| 79 | // they'll be processed. |
| 80 | std::deque<AbstractAction*> actions_; |
| 81 | |
Alex Vakulenko | 072359c | 2014-07-18 11:41:07 -0700 | [diff] [blame] | 82 | // A pointer to the currently processing Action, if any. |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 83 | AbstractAction* current_action_; |
| 84 | |
Alex Vakulenko | 88b591f | 2014-08-28 16:48:57 -0700 | [diff] [blame] | 85 | // A pointer to the delegate, or null if none. |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 86 | ActionProcessorDelegate *delegate_; |
| 87 | DISALLOW_COPY_AND_ASSIGN(ActionProcessor); |
| 88 | }; |
| 89 | |
| 90 | // A delegate object can be used to be notified of events that happen |
| 91 | // in an ActionProcessor. An instance of this class can be passed to an |
| 92 | // ActionProcessor to register itself. |
| 93 | class ActionProcessorDelegate { |
| 94 | public: |
Alex Deymo | e894870 | 2014-11-11 21:44:45 -0800 | [diff] [blame] | 95 | virtual ~ActionProcessorDelegate() = default; |
| 96 | |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 97 | // Called when all processing in an ActionProcessor has completed. A pointer |
Darin Petkov | c1a8b42 | 2010-07-19 11:34:49 -0700 | [diff] [blame] | 98 | // to the ActionProcessor is passed. |code| is set to the exit code of the |
| 99 | // last completed action. |
| 100 | virtual void ProcessingDone(const ActionProcessor* processor, |
David Zeuthen | a99981f | 2013-04-29 13:42:47 -0700 | [diff] [blame] | 101 | ErrorCode code) {} |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 102 | |
| 103 | // Called when processing has stopped. Does not mean that all Actions have |
| 104 | // completed. If/when all Actions complete, ProcessingDone() will be called. |
| 105 | virtual void ProcessingStopped(const ActionProcessor* processor) {} |
| 106 | |
| 107 | // Called whenever an action has finished processing, either successfully |
| 108 | // or otherwise. |
adlr@google.com | c98a7ed | 2009-12-04 18:54:03 +0000 | [diff] [blame] | 109 | virtual void ActionCompleted(ActionProcessor* processor, |
| 110 | AbstractAction* action, |
David Zeuthen | a99981f | 2013-04-29 13:42:47 -0700 | [diff] [blame] | 111 | ErrorCode code) {} |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 112 | }; |
| 113 | |
| 114 | } // namespace chromeos_update_engine |
| 115 | |
Gilad Arnold | cf175a0 | 2014-07-10 16:48:47 -0700 | [diff] [blame] | 116 | #endif // UPDATE_ENGINE_ACTION_PROCESSOR_H_ |