Interface ClientStream<RequestT> (2.8.1)
Stay organized with collections
Save and categorize content based on your preferences.
public interface ClientStream<RequestT>
A wrapper used to send requests to the server.
After sending requests, users must either call #closeSend() or #closeSendWithError(Throwable) on the stream. The error, if any, will be propagated to the
server.
Example usage:
ClientStream<String> stream = ...;
List<String> lines = getLinesFromFile();
for (String line : lines) {
stream.send(line);
}
stream.closeSend();
Type Parameter
Methods
closeSend()
public abstract void closeSend()
Closes the stream. If called, this must be the last call on this ClientStream
.
Note that if close()
itself throws, a further call to closeSendWithError
is
not allowed.
closeSendWithError(Throwable t)
public abstract void closeSendWithError(Throwable t)
Closes the stream with an error. If called, this must be the last call on this
ClientStream
.
Parameter
isSendReady()
public abstract boolean isSendReady()
Reports whether a new request can be sent without excessive buffering.
This is only an optimization hint to the user. It is correct, if suboptimal, to call
send
if isSendReady
returns false.
Returns
send(RequestT request)
public abstract void send(RequestT request)
Sends a request to the server. It is an error to call this if the stream is already closed.
Parameter
Name | Description |
request | RequestT
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-19 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
{"lastModified": "Last updated 2024-09-19 UTC."}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-19 UTC."]]