#import <ProtoRPC.h>
Instance Methods | |
| (void) | - cancel |
| (void) | - finish |
| (nullable instancetype) | - initWithRequestOptions:responseHandler:callOptions:responseClass: |
| (instancetype) | - NS_UNAVAILABLE |
| (void) | - receiveNextMessage |
| (void) | - receiveNextMessages: |
| (void) | - start |
| (void) | - writeMessage: |
Class Methods | |
| (instancetype) | + NS_UNAVAILABLE |
Detailed Description
A client-streaming RPC call with Protobuf.
Definition at line 132 of file ProtoRPC.h.
Method Documentation
◆ cancel
| - (void) cancel |
Cancel the request of this call at best effort. It attempts to notify the server that the RPC should be cancelled, and issue didCloseWithTrailingMetadata:error: callback with error code CANCELED if no other error code has already been issued.
◆ finish
| - (void) finish |
Finish the RPC request and half-close the call. The server may still send messages and/or trailers to the client.
◆ initWithRequestOptions:responseHandler:callOptions:responseClass:
| - (nullable instancetype) initWithRequestOptions: | (GRPCRequestOptions *) | requestOptions | |
| responseHandler: | (id< GRPCProtoResponseHandler >) | handler | |
| callOptions: | (nullable GRPCCallOptions *) | callOptions | |
| responseClass: | (Class) | NS_DESIGNATED_INITIALIZER | |
Users should not use this initializer directly. Call objects will be created, initialized, and returned to users by methods of the generated service.
◆ NS_UNAVAILABLE [1/2]
| + (instancetype) NS_UNAVAILABLE |
◆ NS_UNAVAILABLE [2/2]
| - (instancetype) NS_UNAVAILABLE |
◆ receiveNextMessage
| - (void) receiveNextMessage |
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.
◆ receiveNextMessages:
| - (void) receiveNextMessages: | (NSUInteger) | numberOfMessages |
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.
◆ start
| - (void) start |
Start the call. This function must only be called once for each instance.
◆ writeMessage:
| - (void) writeMessage: | (GPBMessage *) | message |
Send a message to the server. The message should be a Protobuf message which will be serialized internally.
The documentation for this class was generated from the following file: