xref: /aosp_15_r20/external/grpc-grpc/src/objective-c/GRPCClient/GRPCTransport.h (revision cc02d7e222339f7a4f6ba5f422e6413f4bd931f2)

/*
 *
 * Copyright 2019 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.
 *
 */

// The interface for a transport implementation

#import "GRPCInterceptor.h"

NS_ASSUME_NONNULL_BEGIN

#pragma mark Transport ID

/**
 * The default transport implementations available in gRPC. These implementations will be provided
 * by gRPC by default unless explicitly excluded by the build system.
 */
extern const struct GRPCDefaultTransportImplList {
  const GRPCTransportID core_secure;
  const GRPCTransportID core_insecure;
} GRPCDefaultTransportImplList;

/** Returns whether two transport id's are identical. */
BOOL TransportIDIsEqual(GRPCTransportID lhs, GRPCTransportID rhs);

/** Returns the hash value of a transport id. */
NSUInteger TransportIDHash(GRPCTransportID);

#pragma mark Transport and factory

@protocol GRPCInterceptorInterface;
@protocol GRPCResponseHandler;
@class GRPCTransportManager;
@class GRPCRequestOptions;
@class GRPCCallOptions;
@class GRPCTransport;

/** The factory to create a transport. */
@protocol GRPCTransportFactory <NSObject>

/** Create a transport implementation instance. */
- (GRPCTransport *)createTransportWithManager:(GRPCTransportManager *)transportManager;

/** Get a list of factories for transport inteceptors. */
@property(nonatomic, readonly) NSArray<id<GRPCInterceptorFactory>> *transportInterceptorFactories;

@end

/** The registry of transport implementations. */
@interface GRPCTransportRegistry : NSObject

+ (instancetype)sharedInstance;

/**
 * Register a transport implementation with the registry. All transport implementations to be used
 * in a process must register with the registry on process start-up in its +load: class method.
 * Parameter \p transportID is the identifier of the implementation, and \p factory is the factory
 * object to create the corresponding transport instance.
 */
- (void)registerTransportWithID:(GRPCTransportID)transportID
                        factory:(id<GRPCTransportFactory>)factory;

@end

/**
 * Base class for transport implementations. All transport implementation should inherit from this
 * class.
 */
@interface GRPCTransport : NSObject <GRPCInterceptorInterface>

@end

NS_ASSUME_NONNULL_END