aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/objective-c/RxLibrary/GRXConcurrentWriteable.m
blob: 115195463de35626b128c582250d73c2d5566841 (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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
/*
 *
 * Copyright 2015 gRPC authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

#import "GRXConcurrentWriteable.h"

#import <RxLibrary/GRXWriteable.h>

@interface GRXConcurrentWriteable ()
// This is atomic so that cancellation can nillify it from any thread.
@property(atomic, strong) id<GRXWriteable> writeable;
@end

@implementation GRXConcurrentWriteable {
  dispatch_queue_t _writeableQueue;

  // This ivar ensures that writesFinishedWithError: is only sent once to the writeable. Protected
  // by _writeableQueue.
  BOOL _alreadyFinished;

  // This ivar ensures that a cancelWithError: call prevents further values to be sent to
  // self.writeable. It must support manipulation outside of _writeableQueue and thus needs to be
  // protected by self lock.
  BOOL _cancelled;
}

- (instancetype)init {
  return [self initWithWriteable:nil];
}

// Designated initializer
- (instancetype)initWithWriteable:(id<GRXWriteable>)writeable
                    dispatchQueue:(dispatch_queue_t)queue {
  if (self = [super init]) {
    _writeableQueue = queue;
    _writeable = writeable;
    _alreadyFinished = NO;
    _cancelled = NO;
  }
  return self;
}

- (instancetype)initWithWriteable:(id<GRXWriteable>)writeable {
  return [self initWithWriteable:writeable dispatchQueue:dispatch_get_main_queue()];
}

- (void)enqueueValue:(id)value completionHandler:(void (^)(void))handler {
  dispatch_async(_writeableQueue, ^{
    if (self->_alreadyFinished) {
      return;
    }

    @synchronized(self) {
      if (self->_cancelled) {
        return;
      }
    }

    [self.writeable writeValue:value];
    handler();
  });
}

- (void)enqueueSuccessfulCompletion {
  dispatch_async(_writeableQueue, ^{
    if (self->_alreadyFinished) {
      return;
    }
    @synchronized(self) {
      if (self->_cancelled) {
        return;
      }
    }
    [self.writeable writesFinishedWithError:nil];

    // Skip any possible message to the wrapped writeable enqueued after this one.
    self->_alreadyFinished = YES;
    self.writeable = nil;
  });
}

- (void)cancelWithError:(NSError *)error {
  NSAssert(error != nil, @"For a successful completion, use enqueueSuccessfulCompletion.");
  @synchronized(self) {
    self->_cancelled = YES;
  }
  dispatch_async(_writeableQueue, ^{
    if (self->_alreadyFinished) {
      // a cancel or a successful completion is already issued
      return;
    }
    [self.writeable writesFinishedWithError:error];

    // Skip any possible message to the wrapped writeable enqueued after this one.
    self->_alreadyFinished = YES;
    self.writeable = nil;
  });
}

- (void)cancelSilently {
  dispatch_async(_writeableQueue, ^{
    if (self->_alreadyFinished) {
      return;
    }
    self.writeable = nil;
  });
}
@end