xref: /aosp_15_r20/external/grpc-grpc/src/objective-c/RxLibrary/GRXWriteable.h (revision cc02d7e222339f7a4f6ba5f422e6413f4bd931f2)
1*cc02d7e2SAndroid Build Coastguard Worker /*
2*cc02d7e2SAndroid Build Coastguard Worker  *
3*cc02d7e2SAndroid Build Coastguard Worker  * Copyright 2015 gRPC authors.
4*cc02d7e2SAndroid Build Coastguard Worker  *
5*cc02d7e2SAndroid Build Coastguard Worker  * Licensed under the Apache License, Version 2.0 (the "License");
6*cc02d7e2SAndroid Build Coastguard Worker  * you may not use this file except in compliance with the License.
7*cc02d7e2SAndroid Build Coastguard Worker  * You may obtain a copy of the License at
8*cc02d7e2SAndroid Build Coastguard Worker  *
9*cc02d7e2SAndroid Build Coastguard Worker  *     http://www.apache.org/licenses/LICENSE-2.0
10*cc02d7e2SAndroid Build Coastguard Worker  *
11*cc02d7e2SAndroid Build Coastguard Worker  * Unless required by applicable law or agreed to in writing, software
12*cc02d7e2SAndroid Build Coastguard Worker  * distributed under the License is distributed on an "AS IS" BASIS,
13*cc02d7e2SAndroid Build Coastguard Worker  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14*cc02d7e2SAndroid Build Coastguard Worker  * See the License for the specific language governing permissions and
15*cc02d7e2SAndroid Build Coastguard Worker  * limitations under the License.
16*cc02d7e2SAndroid Build Coastguard Worker  *
17*cc02d7e2SAndroid Build Coastguard Worker  */
18*cc02d7e2SAndroid Build Coastguard Worker 
19*cc02d7e2SAndroid Build Coastguard Worker #import <Foundation/Foundation.h>
20*cc02d7e2SAndroid Build Coastguard Worker 
21*cc02d7e2SAndroid Build Coastguard Worker /**
22*cc02d7e2SAndroid Build Coastguard Worker  * A GRXWriteable is an object to which a sequence of values can be sent. The
23*cc02d7e2SAndroid Build Coastguard Worker  * sequence finishes with an optional error.
24*cc02d7e2SAndroid Build Coastguard Worker  */
25*cc02d7e2SAndroid Build Coastguard Worker @protocol GRXWriteable <NSObject>
26*cc02d7e2SAndroid Build Coastguard Worker 
27*cc02d7e2SAndroid Build Coastguard Worker /** Push the next value of the sequence to the receiving object. */
28*cc02d7e2SAndroid Build Coastguard Worker - (void)writeValue:(id)value;
29*cc02d7e2SAndroid Build Coastguard Worker 
30*cc02d7e2SAndroid Build Coastguard Worker /**
31*cc02d7e2SAndroid Build Coastguard Worker  * Signal that the sequence is completed, or that an error occurred. After this
32*cc02d7e2SAndroid Build Coastguard Worker  * message is sent to the instance, neither it nor writeValue: may be
33*cc02d7e2SAndroid Build Coastguard Worker  * called again.
34*cc02d7e2SAndroid Build Coastguard Worker  */
35*cc02d7e2SAndroid Build Coastguard Worker - (void)writesFinishedWithError:(NSError *)errorOrNil;
36*cc02d7e2SAndroid Build Coastguard Worker @end
37*cc02d7e2SAndroid Build Coastguard Worker 
38*cc02d7e2SAndroid Build Coastguard Worker typedef void (^GRXValueHandler)(id value);
39*cc02d7e2SAndroid Build Coastguard Worker typedef void (^GRXCompletionHandler)(NSError *errorOrNil);
40*cc02d7e2SAndroid Build Coastguard Worker typedef void (^GRXSingleHandler)(id value, NSError *errorOrNil);
41*cc02d7e2SAndroid Build Coastguard Worker typedef void (^GRXEventHandler)(BOOL done, id value, NSError *error);
42*cc02d7e2SAndroid Build Coastguard Worker 
43*cc02d7e2SAndroid Build Coastguard Worker /**
44*cc02d7e2SAndroid Build Coastguard Worker  * Utility to create objects that conform to the GRXWriteable protocol, from
45*cc02d7e2SAndroid Build Coastguard Worker  * blocks that handle each of the two methods of the protocol.
46*cc02d7e2SAndroid Build Coastguard Worker  */
47*cc02d7e2SAndroid Build Coastguard Worker @interface GRXWriteable : NSObject <GRXWriteable>
48*cc02d7e2SAndroid Build Coastguard Worker 
49*cc02d7e2SAndroid Build Coastguard Worker + (instancetype)writeableWithSingleHandler:(GRXSingleHandler)handler;
50*cc02d7e2SAndroid Build Coastguard Worker + (instancetype)writeableWithEventHandler:(GRXEventHandler)handler;
51*cc02d7e2SAndroid Build Coastguard Worker 
52*cc02d7e2SAndroid Build Coastguard Worker - (instancetype)initWithValueHandler:(GRXValueHandler)valueHandler
53*cc02d7e2SAndroid Build Coastguard Worker                    completionHandler:(GRXCompletionHandler)completionHandler
54*cc02d7e2SAndroid Build Coastguard Worker     NS_DESIGNATED_INITIALIZER;
55*cc02d7e2SAndroid Build Coastguard Worker @end
56