A co-worker recently asked me about the difference between -replay
, -replayLast
, and -replayLazily
in the ReactiveCocoa library. I had a vague understanding of the three but was not able to confidently explain the difference, so I thought I would look into it further.
I found the header documentation to be difficult to understand if you don’t have a good understanding of RACReplaySubject
and RACMulticastConnection
, so I’m going to try to explain the replay methods without getting into those underlying concepts.
Subscribing to a Signal
With a “normal” RACSignal
each subscription to the signal causes the subscription code to be executed again, and the subscriber only receives values that are sent after the subscription is made. I think it is easiest to show this in two different examples.
The first example shows how the subscription code gets re-executed on each subscription.
1 |
__block int num = 0; |
Running this example will produce:
1 |
Start subscriptions |
As you can see, each subscription causes num
to be incremented. Also note that num
is not incremented until a subscription is made. In this way, a normal RACSignal can be thought of as lazy, as it doesn’t do any work until it has a subscriber.
Our second example shows how each subscriber only receives the values that are sent after their subscription is added.
1 |
RACSubject *letters = [RACSubject subject]; |
1 |
Subscribe S1 |
In many cases this is the desired behavior. But in some cases, you don’t want the subscription code to be re-executed, e.g. a subscription makes a request to a web service and there are multiple listeners that need to be updated when the result comes in. Or maybe you want to get the history of values that have been sent on the signal prior to a subscription. This is where -replay
, -replayLast
, and -replayLazily
can be used.
Subscribing to a -replay Signal
The -replay
convenience method returns a new signal that, when subscribed to, will immediately send the subscriber the entire history of values that have come through the source signal, without re-executing the source signal’s subscription code. The subscriber will still receive all future values from the signal just as it would from a normal signal.
The first example shows how the subscription code is not re-executed upon new subscriptions:
1 |
__block int num = 0; |
1 |
Increment num to: 1 |
This time the num
integer is incremented immediately, before there are even any subscribers. And it is only incremented once, meaning that the subscription code is only been executed a single time, regardless of how many subscribers the signal has.
The second example shows how each new subscriber receives the full history of the signal:
1 |
RACSubject *letters = [RACSubject subject]; |
1 |
Subscribe S1 |
Even though S3 subscribed after all of the values had been sent, it still received all of the values.
Subscribing to a -replayLast Signal
The -replayLast
convenience method returns a new signal that, when subscribed to, will immediately send the subscriber the most recent value that comes through the source signal, without re-executing the source signal’s subscription code. The subscriber will then receive all future values from the signal just as it would from a normal signal.
For the first example, there is no difference between -replayLast
and -replay
so I won’t bother showing it again.
The second example illustrates how only the most recent value is provided to a new subscriber.
1 |
RACSubject *letters = [RACSubject subject]; |
1 |
Subscribe S1 |
Subscribing to a -replayLazily Signal
The -replayLazily
convenience method returns a new signal that, when subscribed to, will immediately send the subscriber the entire history of values that have come through the source signal, without re-executing the source signal’s subscription code. The difference between -replayLazily
and -replay
is that -replayLazily
will not subscribe to the source signal until something subscribes to the newly created signal. This is opposed to the behavior of -replay
and -replayLast
, which subscribe to the source signal immediately upon being called.
The first example illustrates this difference. Note how the “Increment num to: 1” message does not appear until after the first subscription. With -replay
(and -replayLast
) the same message appears before the first subscription.
1 |
__block int num = 0; |
1 |
Start subscriptions |
And the second example shows that the full history is sent to any new subscribers, just like with -replay
.
1 |
RACSubject *letters = [RACSubject subject]; |
1 |
Subscribe S1 |
Summary
ReactiveCocoa provides three convenience methods for allowing multiple subscribers to the same signal, without re-executing the source signal’s subscription code, and to provide some level of historical values to later subscribers. -replay
and -replayLast
both make the signal hot, and will provide either all values (-replay
) or the most recent (-replayLast
) value to subscribers. -replayLazily
returns a cold signal that will provide all of the signal’s values to subscribers.