1 // Copyright 2012 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 SYNC_API_SYNC_ERROR_H_ 6 #define SYNC_API_SYNC_ERROR_H_ 7 8 #include <iosfwd> 9 #include <string> 10 11 #include "base/memory/scoped_ptr.h" 12 #include "sync/base/sync_export.h" 13 #include "sync/internal_api/public/base/model_type.h" 14 15 namespace tracked_objects { 16 class Location; 17 } // namespace tracked_objects 18 19 namespace syncer { 20 21 // Sync errors are used for debug purposes and handled internally and/or 22 // exposed through Chrome's "about:sync" internal page. 23 // This class is copy-friendly and thread-safe. 24 class SYNC_EXPORT SyncError { 25 public: 26 // Error types are used to distinguish general datatype errors (which result 27 // in the datatype being disabled) from actionable sync errors (which might 28 // have more complicated results). 29 enum ErrorType { 30 UNSET, // No error. 31 UNRECOVERABLE_ERROR, // An unrecoverable runtime error was encountered, and 32 // sync should be disabled completely. 33 DATATYPE_ERROR, // A datatype error was encountered, and the datatype 34 // should be disabled. 35 PERSISTENCE_ERROR, // A persistence error was detected, and the 36 // datataype should be associated after a sync update. 37 CRYPTO_ERROR, // A cryptographer error was detected, and the 38 // datatype should be associated after it is resolved. 39 }; 40 41 // Default constructor refers to "no error", and IsSet() will return false. 42 SyncError(); 43 44 // Create a new Sync error of type |error_type| triggered by |model_type| 45 // from the specified location. IsSet() will return true afterward. Will 46 // create and print an error specific message to LOG(ERROR). 47 SyncError(const tracked_objects::Location& location, 48 ErrorType error_type, 49 const std::string& message, 50 ModelType model_type); 51 52 // Copy and assign via deep copy. 53 SyncError(const SyncError& other); 54 SyncError& operator=(const SyncError& other); 55 56 ~SyncError(); 57 58 // Reset the current error to a new datatype error. May be called 59 // irrespective of whether IsSet() is true. After this is called, IsSet() 60 // will return true. 61 // Will print the new error to LOG(ERROR). 62 void Reset(const tracked_objects::Location& location, 63 const std::string& message, 64 ModelType type); 65 66 // Whether this is a valid error or not. 67 bool IsSet() const; 68 69 // These must only be called if IsSet() is true. 70 const tracked_objects::Location& location() const; 71 const std::string& message() const; 72 ModelType model_type() const; 73 ErrorType error_type() const; 74 75 // Returns empty string is IsSet() is false. 76 std::string ToString() const; 77 private: 78 // Print error information to log. 79 void PrintLogError() const; 80 81 // Make a copy of a SyncError. If other.IsSet() == false, this->IsSet() will 82 // now return false. 83 void Copy(const SyncError& other); 84 85 // Initialize the local error data with the specified error data. After this 86 // is called, IsSet() will return true. 87 void Init(const tracked_objects::Location& location, 88 const std::string& message, 89 ModelType model_type, 90 ErrorType error_type); 91 92 // Reset the error to it's default (unset) values. 93 void Clear(); 94 95 // scoped_ptr is necessary because Location objects aren't assignable. 96 scoped_ptr<tracked_objects::Location> location_; 97 std::string message_; 98 ModelType model_type_; 99 ErrorType error_type_; 100 }; 101 102 // gmock printer helper. 103 SYNC_EXPORT void PrintTo(const SyncError& sync_error, std::ostream* os); 104 105 } // namespace syncer 106 107 #endif // SYNC_API_SYNC_ERROR_H_ 108