Skip to content
Snippets Groups Projects
Commit ca0d12a3 authored by Muxi Yan's avatar Muxi Yan
Browse files

Polish and add comments

parent bd30e739
Branches
Tags
No related merge requests found
...@@ -269,6 +269,12 @@ extern NSString *const kGRPCTrailersKey; ...@@ -269,6 +269,12 @@ extern NSString *const kGRPCTrailersKey;
*/ */
- (void)finish; - (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; - (void)receiveNextMessages:(NSUInteger)numberOfMessages;
/** /**
... ...
......
...@@ -138,16 +138,22 @@ NS_ASSUME_NONNULL_BEGIN ...@@ -138,16 +138,22 @@ NS_ASSUME_NONNULL_BEGIN
- (void)finish; - (void)finish;
/** /**
* Tell gRPC to receive the next message. If flow control is enabled, the messages received from the * Tell gRPC to receive another message.
* 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. * 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; - (void)receiveNextMessage;
/** /**
* Tell gRPC to receive the next N message. If flow control is enabled, the messages received from * Tell gRPC to receive another N message.
* 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. * 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; - (void)receiveNextMessages:(NSUInteger)numberOfMessages;
... ...
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please to comment