aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/objective-c/GRPCClient/private/GRPCChannelPool.h
blob: 5ceb0b6d821af1bfabe849838a8757b59afd29c1 (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
/*
 *
 * Copyright 2018 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.
 *
 */

/**
 * Signature for the channel. If two channel's signatures are the same, they share the same
 * underlying \a GRPCChannel object.
 */

#import <GRPCClient/GRPCCallOptions.h>

#import "GRPCChannelFactory.h"

NS_ASSUME_NONNULL_BEGIN

@class GRPCChannel;

@interface GRPCChannelConfiguration : NSObject<NSCopying>

@property(copy, readonly) NSString *host;
@property(strong, readonly) GRPCCallOptions *callOptions;

@property(readonly) id<GRPCChannelFactory> channelFactory;
@property(readonly) NSDictionary *channelArgs;

- (nullable instancetype)initWithHost:(NSString *)host callOptions:(GRPCCallOptions *)callOptions;

@end

/**
 * Manage the pool of connected channels. When a channel is no longer referenced by any call,
 * destroy the channel after a certain period of time elapsed.
 */
@interface GRPCChannelPool : NSObject

- (instancetype)init;

- (instancetype)initWithChannelDestroyDelay:(NSTimeInterval)channelDestroyDelay NS_DESIGNATED_INITIALIZER;

/**
 * Return a channel with a particular configuration. If the channel does not exist, execute \a
 * createChannel then add it in the pool. If the channel exists, increase its reference count.
 */
- (GRPCChannel *)channelWithConfiguration:(GRPCChannelConfiguration *)configuration
                            createChannel:(GRPCChannel * (^)(void))createChannel;

/** Decrease a channel's refcount. */
- (void)unrefChannelWithConfiguration:configuration;

/** Clear all channels in the pool. */
- (void)clear;

@end

NS_ASSUME_NONNULL_END