Instance Methods | Class Methods | Properties | List of all members
GRPCPooledChannel Class Reference

#import <GRPCChannelPool.h>

Inheritance diagram for GRPCPooledChannel:
Inheritance graph
[legend]

Instance Methods

(void) - disconnect
 
(nullable instancetype) - initWithChannelConfiguration:
 
(nullable instancetype) - initWithChannelConfiguration:destroyDelay:
 
(void) - notifyWrappedCallDealloc:
 
(nullable instancetype) - NS_UNAVAILABLE
 
(nullable GRPCWrappedCall *) - wrappedCallWithPath:completionQueue:callOptions:
 

Class Methods

(nullable instancetype) + NS_UNAVAILABLE
 

Properties

GRPCChannelwrappedChannel
 

Detailed Description

A proxied channel object that can be retained and used to create GRPCWrappedCall object regardless of the current connection status. If a connection is not established when a GRPCWrappedCall object is requested, it issues a connection/reconnection. This behavior is to follow that of gRPC core's channel object.

Definition at line 36 of file GRPCChannelPool.h.

Method Documentation

◆ disconnect

- (void) disconnect

Force the channel to disconnect immediately. GRPCWrappedCall objects previously created with wrappedCallWithPath are failed if not already finished. Subsequent calls to unmanagedCallWithPath: will attempt to reconnect to the remote channel.

◆ initWithChannelConfiguration:

- (nullable instancetype) initWithChannelConfiguration: (GRPCChannelConfiguration *)  channelConfiguration

Initialize with an actual channel object channel and a reference to the channel pool.

◆ initWithChannelConfiguration:destroyDelay:

- (nullable instancetype) initWithChannelConfiguration: (GRPCChannelConfiguration *)  channelConfiguration
destroyDelay: (NSTimeInterval)  destroyDelay 

Initialize a pooled channel with non-default destroy delay for testing purpose.

Provided by category GRPCPooledChannel(Test).

◆ notifyWrappedCallDealloc:

- (void) notifyWrappedCallDealloc: (GRPCWrappedCall *)  wrappedCall

Notify the pooled channel that a wrapped call object is no longer referenced and will be dealloc'ed.

◆ NS_UNAVAILABLE [1/2]

+ (nullable instancetype) NS_UNAVAILABLE

◆ NS_UNAVAILABLE [2/2]

- (nullable instancetype) NS_UNAVAILABLE

◆ wrappedCallWithPath:completionQueue:callOptions:

- (nullable GRPCWrappedCall *) wrappedCallWithPath: (NSString *)  path
completionQueue: (GRPCCompletionQueue *)  queue
callOptions: (GRPCCallOptions *)  callOptions 

Create a GRPCWrappedCall object (grpc_call) from this channel. If channel is disconnected, get a new channel object from the channel pool.

Property Documentation

◆ wrappedChannel

- (GRPCChannel*) wrappedChannel
readatomicassign

Return the pointer to the raw channel wrapped.

Provided by category GRPCPooledChannel(Test).

Definition at line 36 of file GRPCChannelPool+Test.h.


The documentation for this class was generated from the following file:


grpc
Author(s):
autogenerated on Fri May 16 2025 03:01:46