OLD | NEW |
(Empty) | |
| 1 // Copyright (c) 2011 The Chromium Authors. All rights reserved. |
| 2 // Use of this source code is governed by a BSD-style license that can be |
| 3 // found in the LICENSE file. |
| 4 |
| 5 #ifndef CHROME_BROWSER_SYNC_API_SYNC_ERROR_H_ |
| 6 #define CHROME_BROWSER_SYNC_API_SYNC_ERROR_H_ |
| 7 #pragma once |
| 8 |
| 9 #include <string> |
| 10 |
| 11 #include "base/memory/scoped_ptr.h" |
| 12 #include "chrome/browser/sync/syncable/model_type.h" |
| 13 |
| 14 namespace tracked_objects { |
| 15 class Location; |
| 16 } // namespace tracked_objects |
| 17 |
| 18 // Sync errors are used for debug purposes and handled internally and/or |
| 19 // exposed through Chrome's "about:sync" internal page. They are considered |
| 20 // unrecoverable for the datatype creating them, and should only be used as |
| 21 // such. |
| 22 // This class is copy-friendly and thread-safe. |
| 23 class SyncError { |
| 24 public: |
| 25 // Default constructor refers to "no error", and IsSet() will return false. |
| 26 SyncError(); |
| 27 |
| 28 // Create a new Sync error triggered by datatype |type| with debug message |
| 29 // |message| from the specified location. IsSet() will return true. |
| 30 // Will print the new error to LOG(ERROR). |
| 31 SyncError(const tracked_objects::Location& location, |
| 32 const std::string& message, |
| 33 syncable::ModelType type); |
| 34 |
| 35 // Copy and assign via deep copy. |
| 36 SyncError(const SyncError& other); |
| 37 SyncError& operator=(const SyncError& other); |
| 38 |
| 39 ~SyncError(); |
| 40 |
| 41 // Reset the current error to a new error. May be called irrespective of |
| 42 // whether IsSet() is true. After this is called, IsSet() will return true. |
| 43 // Will print the new error to LOG(ERROR). |
| 44 void Reset(const tracked_objects::Location& location, |
| 45 const std::string& message, |
| 46 syncable::ModelType type); |
| 47 |
| 48 // Whether this is a valid error or not. |
| 49 bool IsSet() const; |
| 50 |
| 51 // These must only be called if IsSet() is true. |
| 52 const tracked_objects::Location& location() const; |
| 53 const std::string& message() const; |
| 54 syncable::ModelType type() const; |
| 55 |
| 56 private: |
| 57 // Print error information to log. |
| 58 void PrintLogError() const; |
| 59 |
| 60 // Make a copy of a SyncError. If other.IsSet() == false, this->IsSet() will |
| 61 // now return false. |
| 62 void Copy(const SyncError& other); |
| 63 |
| 64 // Initialize the local error data with the specified error data. After this |
| 65 // is called, IsSet() will return true. |
| 66 void Init(const tracked_objects::Location& location, |
| 67 const std::string& message, |
| 68 syncable::ModelType type); |
| 69 |
| 70 // Reset the error to it's default (unset) values. |
| 71 void Clear(); |
| 72 |
| 73 // scoped_ptr is necessary because Location objects aren't assignable. |
| 74 scoped_ptr<tracked_objects::Location> location_; |
| 75 std::string message_; |
| 76 syncable::ModelType type_; |
| 77 }; |
| 78 |
| 79 #endif // CHROME_BROWSER_SYNC_API_SYNC_ERROR_H_ |
OLD | NEW |