iOS/Pods/Realm/include/RLMSyncUtil_Private.hpp

   1 ////////////////////////////////////////////////////////////////////////////
   2 //
   3 // Copyright 2016 Realm Inc.
   4 //
   5 // Licensed under the Apache License, Version 2.0 (the "License");
   6 // you may not use this file except in compliance with the License.
   7 // You may obtain a copy of the License at
   8 //
   9 // http://www.apache.org/licenses/LICENSE-2.0
  10 //
  11 // Unless required by applicable law or agreed to in writing, software
  12 // distributed under the License is distributed on an "AS IS" BASIS,
  13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 // See the License for the specific language governing permissions and
  15 // limitations under the License.
  16 //
  17 ////////////////////////////////////////////////////////////////////////////
  18
  19 #import "RLMSyncUtil_Private.h"
  20
  21 #import "RLMSyncConfiguration_Private.h"
  22 #import "RLMSyncPermission.h"
  23
  24 #import "sync/sync_manager.hpp"
  25 #import "realm/util/optional.hpp"
  26
  27 @class RLMSyncErrorResponseModel;
  28 class CocoaSyncUserContext;
  29
  30 namespace realm {
  31 enum class AccessLevel;
  32 }
  33
  34 realm::SyncSessionStopPolicy translateStopPolicy(RLMSyncStopPolicy stopPolicy);
  35 RLMSyncStopPolicy translateStopPolicy(realm::SyncSessionStopPolicy stop_policy);
  36
  37 std::shared_ptr<realm::SyncSession> sync_session_for_realm(RLMRealm *realm);
  38
  39 #pragma mark - Get user context
  40
  41 CocoaSyncUserContext& context_for(const std::shared_ptr<realm::SyncUser>& user);
  42
  43 #pragma mark - Access level conversion
  44
  45 realm::AccessLevel accessLevelForObjCAccessLevel(RLMSyncAccessLevel level);
  46 RLMSyncAccessLevel objCAccessLevelForAccessLevel(realm::AccessLevel level);
  47
  48 #pragma mark - Error conversion
  49
  50 typedef enum : NSUInteger {
  51     RLMPermissionActionTypeGet,
  52     RLMPermissionActionTypeChange,
  53     RLMPermissionActionTypeOffer,
  54     RLMPermissionActionTypeAcceptOffer,
  55 } RLMPermissionActionType;
  56
  57 NSError *translateSyncExceptionPtrToError(std::exception_ptr ptr, RLMPermissionActionType type);
  58
  59 #pragma mark - Error construction
  60
  61 NSError *make_auth_error_bad_response(NSDictionary *json=nil);
  62 NSError *make_auth_error_http_status(NSInteger status);
  63 NSError *make_auth_error_client_issue();
  64 NSError *make_auth_error(RLMSyncErrorResponseModel *responseModel);
  65
  66 NSError *make_permission_error_get(NSString *description, realm::util::Optional<NSInteger> code=none);
  67 NSError *make_permission_error_change(NSString *description, realm::util::Optional<NSInteger> code=none);
  68 NSError *make_permission_error_offer(NSString *description, realm::util::Optional<NSInteger> code=none);
  69 NSError *make_permission_error_accept_offer(NSString *description, realm::util::Optional<NSInteger> code=none);
  70
  71 // Set 'code' to NSNotFound to not actually have an error code.
  72 NSError *make_sync_error(RLMSyncSystemErrorKind kind, NSString *description, NSInteger code, NSDictionary *custom);
  73 NSError *make_sync_error(NSError *wrapped_auth_error);
  74 NSError *make_sync_error(std::error_code, RLMSyncSystemErrorKind kind=RLMSyncSystemErrorKindSession);