Polish and add comments

pull/17936/head
Muxi Yan 6 years ago
parent bd30e73995
commit ca0d12a3c3
  1. 6
      src/objective-c/GRPCClient/GRPCCall.h
  2. 18
      src/objective-c/ProtoRPC/ProtoRPC.h

@ -269,6 +269,12 @@ extern NSString *const kGRPCTrailersKey;
*/
- (void)finish;
/**
* Tell gRPC to receive the next N gRPC message from gRPC core.
*
* This method should only be used when flow control is enabled. When flow control is not enabled,
* this method is a no-op.
*/
- (void)receiveNextMessages:(NSUInteger)numberOfMessages;
/**

@ -138,16 +138,22 @@ NS_ASSUME_NONNULL_BEGIN
- (void)finish;
/**
* Tell gRPC to receive the next message. If flow control is enabled, the messages received from the
* server are buffered in gRPC until the user want to receive the next message. If flow control is
* not enabled, messages will be automatically received after the previous one is delivered.
* Tell gRPC to receive another message.
*
* This method should only be used when flow control is enabled. If flow control is enabled, gRPC
* will only receive additional messages after the user indicates so by using either
* receiveNextMessage: or receiveNextMessages: methods. If flow control is not enabled, messages
* will be automatically received after the previous one is delivered.
*/
- (void)receiveNextMessage;
/**
* Tell gRPC to receive the next N message. If flow control is enabled, the messages received from
* the server are buffered in gRPC until the user want to receive the next message. If flow control
* is not enabled, messages will be automatically received after the previous one is delivered.
* Tell gRPC to receive another N message.
*
* This method should only be used when flow control is enabled. If flow control is enabled, the
* messages received from the server are buffered in gRPC until the user want to receive the next
* message. If flow control is not enabled, messages will be automatically received after the
* previous one is delivered.
*/
- (void)receiveNextMessages:(NSUInteger)numberOfMessages;

Loading…
Cancel
Save