iOS/Pods/FirebaseMessaging/Firebase/Messaging/FIRMessagingRmq2PersistentStore.h

   1 /*
   2  * Copyright 2017 Google
   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  */
  16
  17 #import <Foundation/Foundation.h>
  18
  19 @class FIRMessagingPersistentSyncMessage;
  20
  21 // table data handlers
  22 /**
  23  *  Handle message stored in the outgoing RMQ messages table.
  24  *
  25  *  @param rmqId The rmqID of the message.
  26  *  @param tag   The message tag.
  27  *  @param data  The data stored in the message.
  28  */
  29 typedef void(^FCMOutgoingRmqMessagesTableHandler)(int64_t rmqId, int8_t tag, NSData *data);
  30
  31 /// Outgoing messages RMQ table
  32 extern NSString *const kTableOutgoingRmqMessages;
  33 /// Server to device RMQ table
  34 extern NSString *const kTableS2DRmqIds;
  35
  36 @interface FIRMessagingRmq2PersistentStore : NSObject
  37
  38 /**
  39  *  Initialize and open the RMQ database on the client.
  40  *
  41  *  @param databaseName The name for RMQ database.
  42  *
  43  *  @return A store used to persist messages on the client.
  44  */
  45 - (instancetype)initWithDatabaseName:(NSString *)databaseName;
  46
  47 /**
  48  *  Save outgoing message in RMQ.
  49  *
  50  *  @param rmqId The rmqID for the message.
  51  *  @param tag   The tag of the message proto.
  52  *  @param data  The data being sent in the message.
  53  *  @param error The error if any while saving the message to the persistent store.
  54  *
  55  *  @return YES if the message was successfully saved to the persistent store else NO.
  56  */
  57 - (BOOL)saveMessageWithRmqId:(int64_t)rmqId
  58                          tag:(int8_t)tag
  59                         data:(NSData *)data
  60                        error:(NSError **)error;
  61
  62 /**
  63  *  Add unacked server to device message with a given rmqID to the persistent store.
  64  *
  65  *  @param rmqId The rmqID of the message that was not acked by the cient.
  66  *
  67  *  @return YES if the save was successful else NO.
  68  */
  69 - (BOOL)saveUnackedS2dMessageWithRmqId:(NSString *)rmqId;
  70
  71 /**
  72  *  Update the last RMQ ID that was sent by the client.
  73  *
  74  *  @param rmqID The latest rmqID sent by the device.
  75  *
  76  *  @return YES if the last rmqID was successfully saved else NO.
  77  */
  78 - (BOOL)updateLastOutgoingRmqId:(int64_t)rmqID;
  79
  80 #pragma mark - Query
  81
  82 /**
  83  *  Query the highest rmqID saved in the Outgoing messages table.
  84  *
  85  *  @return The highest rmqID amongst all the messages in the Outgoing RMQ table. If no message
  86  *          was ever persisted return 0.
  87  */
  88 - (int64_t)queryHighestRmqId;
  89
  90 /**
  91  *  The last rmqID that was saved on the client.
  92  *
  93  *  @return The last rmqID that was saved. If no rmqID was ever persisted return 0.
  94  */
  95 - (int64_t)queryLastRmqId;
  96
  97 /**
  98  *  Get a list of all unacked server to device messages stored on the client.
  99  *
 100  *  @return List of all unacked s2d messages in the persistent store.
 101  */
 102 - (NSArray *)unackedS2dRmqIds;
 103
 104 /**
 105  *  Iterate over all outgoing messages in the RMQ table.
 106  *
 107  *  @param handler The handler invoked with each message in the outgoing RMQ table.
 108  */
 109 - (void)scanOutgoingRmqMessagesWithHandler:(FCMOutgoingRmqMessagesTableHandler)handler;
 110
 111 #pragma mark - Delete
 112
 113 /**
 114  *  Delete messages with given rmqID's from a table.
 115  *
 116  *  @param tableName The table name from which to delete the rmq messages.
 117  *  @param rmqIds    The rmqID's of the messages to be deleted.
 118  *
 119  *  @return The number of messages that were successfully deleted.
 120  */
 121 - (int)deleteMessagesFromTable:(NSString *)tableName
 122                     withRmqIds:(NSArray *)rmqIds;
 123
 124 /**
 125  *  Remove database from the device.
 126  *
 127  *  @param dbName The database name to be deleted.
 128  */
 129 + (void)removeDatabase:(NSString *)dbName;
 130
 131 #pragma mark - Sync Messages
 132
 133 /**
 134  *  Save sync message to persistent store to check for duplicates.
 135  *
 136  *  @param rmqID          The rmqID of the message to save.
 137  *  @param expirationTime The expiration time of the message to save.
 138  *  @param apnsReceived   YES if the message was received via APNS else NO.
 139  *  @param mcsReceived    YES if the message was received via MCS else NO.
 140  *  @param error          The error if any while saving the message to store.
 141  *
 142  *  @return YES if the message was saved successfully else NO.
 143  */
 144 - (BOOL)saveSyncMessageWithRmqID:(NSString *)rmqID
 145                   expirationTime:(int64_t)expirationTime
 146                     apnsReceived:(BOOL)apnsReceived
 147                      mcsReceived:(BOOL)mcsReceived
 148                            error:(NSError **)error;
 149
 150 /**
 151  *  Update sync message received via APNS.
 152  *
 153  *  @param rmqID The rmqID of the sync message.
 154  *  @param error The error if any while updating the sync message in persistence.
 155  *
 156  *  @return YES if the update was successful else NO.
 157  */
 158 - (BOOL)updateSyncMessageViaAPNSWithRmqID:(NSString *)rmqID
 159                                     error:(NSError **)error;
 160
 161 /**
 162  *  Update sync message received via MCS.
 163  *
 164  *  @param rmqID The rmqID of the sync message.
 165  *  @param error The error if any while updating the sync message in persistence.
 166  *
 167  *  @return YES if the update was successful else NO.
 168  */
 169 - (BOOL)updateSyncMessageViaMCSWithRmqID:(NSString *)rmqID
 170                                    error:(NSError **)error;
 171
 172 /**
 173  *  Query sync message table for a given rmqID.
 174  *
 175  *  @param rmqID The rmqID to search for in SYNC_RMQ.
 176  *
 177  *  @return The sync message that was persisted with `rmqID`. If no such message was persisted
 178  *          return nil.
 179  */
 180 - (FIRMessagingPersistentSyncMessage *)querySyncMessageWithRmqID:(NSString *)rmqID;
 181
 182 /**
 183  *  Delete sync message with rmqID.
 184  *
 185  *  @param rmqID The rmqID of the message to delete.
 186  *
 187  *  @return YES if a sync message with rmqID was found and deleted successfully else NO.
 188  */
 189 - (BOOL)deleteSyncMessageWithRmqID:(NSString *)rmqID;
 190
 191 /**
 192  *  Delete the expired sync messages from persisten store. Also deletes messages that have been
 193  *  delivered both via APNS and MCS.
 194  *
 195  *  @param error The error if any while deleting the messages.
 196  *
 197  *  @return The total number of messages that were deleted from the persistent store.
 198  */
 199 - (int)deleteExpiredOrFinishedSyncMessages:(NSError **)error;
 200
 201 @end