summaryrefslogtreecommitdiffstats
path: root/macosx/HBDistributedArray.h
blob: b410da47251062b911b7d8f9f135178ba2c94176 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
/*  HBDistributedArray.h $

 This file is part of the HandBrake source code.
 Homepage: <http://handbrake.fr/>.
 It may be used under the terms of the GNU General Public License. */

#import <Cocoa/Cocoa.h>

extern NSString *HBDistributedArrayChanged;

/**
 *  Objects in HBDistributedArray
 *  must implement this protocol.
 */
@protocol HBUniqueObject <NSObject>

@property (nonatomic, readonly) NSString *uuid;

@end

typedef NS_ENUM(NSUInteger, HBDistributedArrayContent) {
    HBDistributedArrayContentAcquired,
    HBDistributedArrayContentReload,
};

/**
 *  HBDistributedArray
 *  a mutable array that share its content between processes.
 *  post a HBDistributedArrayChanged when the content is changed
 *  by another process.
 *
 *  Use beginTransaction and commit to wrap atomic changes to the array.
 *
 *  It is safe to keep a reference to an array object.
 */
@interface HBDistributedArray<ObjectType> : NSMutableArray

- (instancetype)initWithURL:(NSURL *)fileURL class:(Class)objectClass;

/**
 *  Begins a transaction on the array
 *
 *  @return whether the array content changes or not after beginning the transaction.
 */
- (HBDistributedArrayContent)beginTransaction;

/**
 *  Commit the changes and notify
 *  the observers about the changes.
 */
- (void)commit;

@end