Discussion

This corresponds to the ToEnumerable method in Rx.

Returns a sequence which provides values from the signal as they’re sent. Trying to retrieve a value from the sequence which has not yet been sent will block.

Discussion

Any additional nexts will result in a new RACTuple with the latest values from all signals.

signals - The signals to combine. If this collection is empty, the returned signal will immediately complete upon subscription.

Returns a signal which sends RACTuples of the combined values, forwards any error events, and completes when all input signals complete.

Discussion

signals - The signals to combine. If this collection is empty, the returned signal will immediately complete upon subscription. reduceBlock - The block which reduces the latest values from all the signals into one value. It must take as many arguments as the number of signals given. Each argument will be an object argument. The return value must be an object. This argument must not be nil.

Example:

[RACSignal combineLatest:@[ stringSignal, intSignal ] reduce:^(NSString string, NSNumber number) { return [NSString stringWithFormat:@“%@: %@”, string, number]; }];

Returns a signal which sends the results from each invocation of reduceBlock.

Discussion

Events can be sent to new subscribers immediately in the didSubscribe block, but the subscriber will not be able to dispose of the signal until a RACDisposable is returned from didSubscribe. In the case of infinite signals, this won’t ever happen if events are sent immediately.

To ensure that the signal is disposable, events can be scheduled on the [RACScheduler currentScheduler] (so that they’re deferred, not sent immediately), or they can be sent in the background. The RACDisposable returned by the didSubscribe block should cancel any such scheduling or asynchronous work.

didSubscribe - Called when the signal is subscribed to. The new subscriber is passed in. You can then manually control the RACSubscriber by sending it -sendNext:, -sendError:, and -sendCompleted, as defined by the operation you’re implementing. This block should return a RACDisposable which cancels any ongoing work triggered by the subscription, and cleans up any resources or disposables created as part of it. When the disposable is disposed of, the signal must not send any more events to the subscriber. If no cleanup is necessary, return nil.

Note: The didSubscribe block is called every time a new subscriber subscribes. Any side effects within the block will thus execute once for each subscription, not necessarily on one thread, and possibly even simultaneously!

Discussion

This can be used to effectively turn a hot signal into a cold signal.

Discussion

boolSignal - A signal of BOOLs determining whether trueSignal or falseSignal should be active. This argument must not be nil. trueSignal - The signal to pass through after boolSignal has sent YES. This argument must not be nil. falseSignal - The signal to pass through after boolSignal has sent NO. This argument must not be nil.

Returns a signal which passes through nexts and errors from trueSignal and/or falseSignal, and sends completed when both boolSignal and the last switched signal complete.

Discussion

interval - The time interval in seconds at which the current time is sent. scheduler - The scheduler upon which the current NSDate should be sent. This must not be nil or [RACScheduler immediateScheduler].

Returns a signal that sends the current date/time every interval on scheduler.

Discussion

The created signal will defer sending each next for at least interval seconds, and for an additional amount of time up to leeway seconds in the interest of performance or power consumption. Note that some additional latency is to be expected, even when specifying a leeway of 0.

interval - The base interval between nexts. scheduler - The scheduler upon which the current NSDate should be sent. This must not be nil or [RACScheduler immediateScheduler]. leeway - The maximum amount of additional time the next can be deferred.

Returns a signal that sends the current date/time at intervals of at least interval seconds up to approximately interval + leeway seconds on scheduler.

Discussion

Returns a signal that passes through values from each of the given signals, and sends completed when all of them complete. If any signal sends an error, the returned signal sends error immediately.

Discussion

scheduler - The scheduler on which block will be scheduled and results delivered. Cannot be nil. block - The block to invoke. Cannot be NULL.

Returns a signal which will send all events sent on the subscriber given to block. All events will be sent on scheduler and it will replay any missed events to new subscribers.

Discussion

Note that disposing of the subscription to the returned signal will not dispose of the underlying subscription. If you need that behavior, see [RACMulticastConnection autoconnect]. The underlying subscription will never be disposed of. Because of this, block should never return an infinite signal since there would be no way of ending it.

scheduler - The scheduler on which the block should be scheduled. Note that if given [RACScheduler immediateScheduler], the block will be invoked synchronously on the first subscription. Cannot be nil. block - The block to invoke on the first subscription. Cannot be NULL.

Returns a signal which will pass through the events sent to the subscriber given to block and replay any missed events to new subscribers.

Discussion

signal - A signal of objects used as keys in the cases dictionary. This argument must not be nil. cases - A dictionary that has signals as values. This argument must not be nil. A RACTupleNil key in this dictionary will match nil next events that are received on signal. defaultSignal - The signal to pass through after signal sends a value for which cases does not contain a signal. If nil, any unmatched values will result in a RACSignalErrorNoMatchingCase error.

Returns a signal which passes through nexts and errors from one of the the signals in cases or defaultSignal, and sends completed when both signal and the last used signal complete. If no defaultSignal is given, an unmatched next will result in an error on the returned signal.

Discussion

predicateBlock - cannot be nil.

Discussion

Asserts if the receiver sends anything other than a RACTuple of one or more NSNumbers.

Returns a signal that applies AND to each NSNumber in the tuple.

Discussion

predicateBlock - cannot be nil.

Discussion

Because this method executes the run loop recursively, it should only be used on the main thread, and only from a unit test.

defaultValue - Returned if the receiver completes or errors before sending a next, or if the method times out. This argument may be nil. success - If not NULL, set to whether the receiver completed successfully. error - If not NULL, set to any error that occurred.

Returns the first value received, or defaultValue if no value is received before the signal finishes or the method times out.

Discussion

Because this method executes the run loop recursively, it should only be used on the main thread, and only from a unit test.

error - If not NULL, set to any error that occurs.

Returns whether the signal completed successfully before timing out. If NO, error will be set to any error that occurred.

Discussion

This should only be used if you need to terminate the bind early, or close over some state. flattenMap: is more appropriate for all other cases.

block - A block returning a RACStreamBindBlock. This block will be invoked each time the bound stream is re-evaluated. This block must not be nil or return nil.

Returns a new stream which represents the combined result of all lazy applications of block.

Discussion

interval - The interval in which values are grouped into one buffer. scheduler - The scheduler upon which the returned signal will deliver its values. This must not be nil or [RACScheduler immediateScheduler].

Returns a signal which sends RACTuples of the buffered values at each interval on scheduler. When the receiver completes, any currently-buffered values will be sent immediately.

Discussion

This corresponds to the ToArray method in Rx.

Returns a signal which sends a single NSArray when the receiver completes successfully.

Discussion

Any additional nexts will result in a new RACTuple with the latest values from both signals.

signal - The signal to combine with. This argument must not be nil.

Returns a signal which sends RACTuples of the combined values, forwards any error events, and completes when both input signals complete.

Discussion

If [RACScheduler currentScheduler] is nil when next or completed is received, a private background scheduler is used.

Returns a signal which sends delayed next and completed events. Errors are always forwarded immediately.

Discussion

This is ideal when the signal already performs its work on the desired thread, but you want to handle its events elsewhere.

This corresponds to the ObserveOn method in Rx.

Discussion

Returns a signal which sends next for each value RACEvent, error for each error RACEvent, and completed for each completed RACEvent.

Discussion

Both success and error may be NULL.

Discussion

If an error occurs on any of the signals, it is sent on the returned signal. It completes only after the receiver and all sent signals have completed.

This corresponds to Merge<TSource>(IObservable<IObservable<TSource>>, Int32) in Rx.

maxConcurrent - the maximum number of signals to subscribe to at a time. If 0, it subscribes to an unlimited number of signals.

Discussion

The returned signal is a signal of RACGroupedSignal.

Discussion

Returns a signal which only passes through error or completed events from the receiver.

Discussion

block - A block which defines the subscription side effects. Cannot be nil.

Example:

// Write new file, with backup. [[[[fileManager rac_createFileAtPath:path contents:data] initially:^{ // 2. Second, backup current file [fileManager moveItemAtPath:path toPath:backupPath error:nil]; }] initially:^{ // 1. First, acquire write lock. [writeLock lock]; }] finally:^{ [writeLock unlock]; }];

Returns a signal that passes through all events of the receiver, plus introduces side effects which occur prior to any subscription side effects of the receiver.

Discussion

Returns a signal which sends the receiver’s events as RACEvents, and completes after the receiver sends completed or error.

Discussion

Returns a signal of inverted NSNumber-wrapped BOOLs.

Discussion

Asserts if the receiver sends anything other than a RACTuple of one or more NSNumbers.

Returns a signal that applies OR to each NSNumber in the tuple.

Discussion

Returns the connected, multicasted signal.

Discussion

Returns the connected, multicasted signal.

Discussion

This means the returned signal will subscribe to the multicasted signal only when the former receives its first subscription.

Returns the lazily connected, multicasted signal.

Discussion

retryCount - if 0, it keeps retrying until it completes.

Discussion

sampler - The signal that controls when the latest value from the receiver is sent. Cannot be nil.

Discussion

Sending an error on the signal is considered undefined behavior, and will generate an assertion failure in Debug builds.

A given key on an object should only have one active signal bound to it at any given time. Binding more than one signal to the same property is considered undefined behavior.

keyPath - The key path to update with nexts from the receiver. object - The object that keyPath is relative to. nilValue - The value to set at the key path whenever nil is sent by the receiver. This may be nil when binding to object properties, but an NSValue should be used for primitive properties, to avoid an exception if nil is sent (which might occur if an intermediate object is set to nil).

Returns a disposable which can be used to terminate the binding.

Discussion

Subscription will always happen on a valid RACScheduler. If the [RACScheduler currentScheduler] cannot be determined at the time of subscription (e.g., because the calling code is running on a GCD queue or NSOperationQueue), subscription will occur on a private background scheduler. On the main thread, subscriptions will always occur immediately, with a [RACScheduler currentScheduler] of [RACScheduler mainThreadScheduler].

This method must be overridden by any subclasses.

Returns nil or a disposable. You can call [RACDisposable dispose] if you need to end your subscription before it would “naturally” end, either by completing or erroring. Once the disposable has been disposed, the subscriber won’t receive any more events from the subscription.

Discussion

This corresponds to the IObserver<T>.OnCompleted in Rx.

Discussion

This corresponds to the IObserver<T>.OnError in Rx.

Discussion

This corresponds to IObserver<T>.OnNext in Rx.

Discussion

Use of this operator should be avoided whenever possible, because the receiver’s side effects may not be safe to run on another thread. If you just want to receive the signal’s events on scheduler, use deliverOn: instead.

Discussion

The receiver must be a signal of signals.

Returns a signal which passes through nexts and errors from the latest signal sent by the receiver, and sends completed when both the receiver and the last sent signal complete.

Discussion

Returns a signal which passes through all events from the receiver until signalTrigger sends next or completed, at which point the returned signal will send completed.

Discussion

replacement - The signal which replaces the receiver as soon as it sends an event.

Returns a signal which passes through nexts and error from the receiver until replacement sends an event, at which point the returned signal will send that event and switch to passing through events from replacement instead, regardless of whether the receiver has sent events already.

Discussion

block - A block which will create or obtain a new signal to subscribe to, executed only after the receiver completes. This block must not be nil, and it must not return a nil signal.

Returns a signal which will pass through the events of the signal created in block. If the receiver errors out, the returned signal will error as well.

Discussion

If a next is received, and then another next is received before interval seconds have passed, the first value is discarded.

After interval seconds have passed since the most recent next was sent, the most recent next is forwarded on the scheduler that the value was originally received on. If [RACScheduler currentScheduler] was nil at the time, a private background scheduler is used.

Returns a signal which sends throttled and delayed next events. Completion and errors are always forwarded immediately.

Discussion

When predicate returns YES for a next:

1. If another next is received before interval seconds have passed, the prior value is discarded. This happens regardless of whether the new value will be throttled.
2. After interval seconds have passed since the value was originally received, it will be forwarded on the scheduler that it was received upon. If [RACScheduler currentScheduler] was nil at the time, a private background scheduler is used.

When predicate returns NO for a next, it is forwarded immediately, without any throttling.

interval - The number of seconds for which to buffer the latest value that passes predicate. predicate - Passed each next from the receiver, this block returns whether the given value should be throttled. This argument must not be nil.

Returns a signal which sends next events, throttled when predicate returns YES. Completion and errors are always forwarded immediately.

Discussion

The error will be in the RACSignalErrorDomain and have a code of RACSignalErrorTimedOut.

interval - The number of seconds after which the signal should error out. scheduler - The scheduler upon which any timeout error should be sent. This must not be nil or [RACScheduler immediateScheduler].

Returns a signal that passes through the receiver’s events, until the stream finishes or times out, at which point an error will be sent on scheduler.

Discussion

This is not the same as the ToArray method in Rx. See collect for that behavior instead.

Returns the array of next values, or nil if an error occurs.

Discussion

tryBlock - An action to run against each of the receiver’s values. The block should return YES to indicate that the action was successful. This block must not be nil.

Example:

// The returned signal will send an error if data values cannot be // written to someFileURL. [signal try:^(NSData *data, NSError **errorPtr) { return [data writeToURL:someFileURL options:NSDataWritingAtomic error:errorPtr]; }];

Returns a signal which passes through all the values of the receiver. If tryBlock fails for any value, the returned signal will error using the NSError passed out from the block.

Discussion

mapBlock - An action to map each of the receiver’s values. The block should return a non-nil value to indicate that the action was successful. This block must not be nil.

Example:

// The returned signal will send an error if data cannot be read from // fileURL. [signal tryMap:^(NSURL *fileURL, NSError **errorPtr) { return [NSData dataWithContentsOfURL:fileURL options:0 error:errorPtr]; }];

Returns a signal which transforms all the values of the receiver. If mapBlock returns nil for any value, the returned signal will error using the NSError passed out from the block.

Discussion

error - If not NULL, set to any error that occurs.

Returns whether the signal completed successfully. If NO, error will be set to the error that occurred.

Discussion

The first next of each stream will be combined, then the second next, and so forth, until either signal completes or errors.

signal - The signal to zip with. This must not be nil.

Returns a new signal of RACTuples, representing the combined values of the two signals. Any error from one of the original signals will be forwarded on the returned signal.