Skip to content

Commit 2f9905e

Browse files
committed
Cleanup comments
1 parent fa807cd commit 2f9905e

File tree

1 file changed

+13
-16
lines changed

1 file changed

+13
-16
lines changed

wire-grpc-client/src/commonMain/kotlin/com/squareup/wire/GrpcStreamingCallExtensions.kt

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,14 @@ import kotlinx.coroutines.channels.ReceiveChannel
2020
import kotlinx.coroutines.channels.SendChannel
2121

2222
/**
23-
* Executes a Client Streaming RPC call This encapsulates the Streaming request, single response use case for wire's
24-
* [GrpcStreamingCall] In this use case, all outbound request messages are sent before the inbound response message.
23+
* Executes a Client Streaming RPC call
24+
* In this use case, all outbound request messages are sent before the inbound response message.
2525
*
2626
* @param scope The [CoroutineScope] to use for the call. This will be used to create coroutines that will write the
2727
* requests to the client message sync. It will also be the context for calling the [block] function
2828
* @param block A function that will be called with a [SendChannel] that the caller can use to send requests to the
2929
* server. The channel will automatically be closed when the block completes.
30-
* @return The optional single response from the server
30+
* @return The single response from the server
3131
*/
3232
suspend inline fun <S : Any, R : Any> GrpcClientStreamingCall<S, R>.clientStream(
3333
scope: CoroutineScope,
@@ -43,13 +43,12 @@ suspend inline fun <S : Any, R : Any> GrpcClientStreamingCall<S, R>.clientStream
4343
}
4444

4545
/**
46-
* Executes a blocking Client Streaming RPC call This encapsulates the Streaming request, single response use case for
47-
* wire's [GrpcStreamingCall] In this use case, all outbound request messages are sent before the inbound response
48-
* message.
46+
* Executes a blocking Client Streaming RPC call
47+
* In this use case, all outbound request messages are sent before the inbound response message.
4948
*
5049
* @param block A function that will be called with a [MessageSink] that the caller can use to send requests to the
51-
* server. The channel will automatically be closed when the block completes.
52-
* @return The optional single response from the server
50+
* server. The sink will automatically be closed when the block completes.
51+
* @return The single response from the server
5352
*/
5453
inline fun <S : Any, R : Any> GrpcClientStreamingCall<S, R>.clientStreamBlocking(
5554
crossinline block: MessageSink<S>.() -> Unit,
@@ -64,10 +63,9 @@ inline fun <S : Any, R : Any> GrpcClientStreamingCall<S, R>.clientStreamBlocking
6463
}
6564

6665
/**
67-
* Executes a Bidirectional Streaming RPC call This encapsulates the Streaming request, streaming response use case for
68-
* wire's [GrpcStreamingCall] In this use case, you are free to interleave request and response messages. The caller can
69-
* optionally send and receive messages in the supplied block or after the block completes in the returned
70-
* [ReceiveChannel].
66+
* Executes a Bidirectional Streaming RPC call
67+
* In this use case, you are free to interleave request and response messages. The caller can optionally send
68+
* and receive messages in the supplied block or after the block completes in the returned [ReceiveChannel].
7169
*
7270
* @param scope The [CoroutineScope] to use for the call. This will be used to create coroutines that will write the
7371
* requests to the client message sync. It will also be the context for calling the [block] function.
@@ -91,10 +89,9 @@ suspend inline fun <S : Any, R : Any> GrpcStreamingCall<S, R>.bidirectionalStrea
9189
}
9290

9391
/**
94-
* Executes a blocking Bidirectional Streaming RPC call This encapsulates the Streaming request, streaming response use
95-
* case for wire's [GrpcStreamingCall] In this use case, you are free to interleave request and response messages. The
96-
* caller can optionally send and receive messages in the supplied block or after the block completes in the returned
97-
* [MessageSource].
92+
* Executes a blocking Bidirectional Streaming RPC call
93+
* In this use case, you are free to interleave request and response messages. The caller can optionally send and
94+
* receive messages in the supplied block or after the block completes in the returned [MessageSource].
9895
*
9996
* @param block A function that will be called with a [MessageSink] and [MessageSource] that the caller can use to send
10097
* requests to the server and consume responses from the server. The send channel will automatically be closed when

0 commit comments

Comments
 (0)