org.springframework.messaging.rsocket.RSocketRequesterExtensions.kt Maven / Gradle / Ivy
/*
* Copyright 2002-2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.messaging.rsocket
import io.rsocket.transport.ClientTransport
import kotlinx.coroutines.flow.Flow
import kotlinx.coroutines.reactive.awaitFirstOrNull
import kotlinx.coroutines.reactive.awaitSingle
import kotlinx.coroutines.reactive.asFlow
import org.reactivestreams.Publisher
import org.springframework.core.ParameterizedTypeReference
import reactor.core.publisher.Flux
import reactor.core.publisher.Mono
import java.net.URI
/**
* Coroutines variant of [RSocketRequester.Builder.connect].
*
* @author Sebastien Deleuze
* @since 5.2
*/
suspend fun RSocketRequester.Builder.connectAndAwait(transport: ClientTransport): RSocketRequester =
connect(transport).awaitSingle()
/**
* Coroutines variant of [RSocketRequester.Builder.connectTcp].
*
* @author Sebastien Deleuze
* @since 5.2
*/
suspend fun RSocketRequester.Builder.connectTcpAndAwait(host: String, port: Int): RSocketRequester =
connectTcp(host, port).awaitSingle()
/**
* Coroutines variant of [RSocketRequester.Builder.connectWebSocket].
*
* @author Sebastien Deleuze
* @since 5.2
*/
suspend fun RSocketRequester.Builder.connectWebSocketAndAwait(uri: URI): RSocketRequester =
connectWebSocket(uri).awaitSingle()
/**
* Extension for [RSocketRequester.RequestSpec.data] providing a `dataWithType(Any)`
* variant leveraging Kotlin reified type parameters. This extension is not subject to type
* erasure and retains actual generic type arguments.
* @param producer the source of payload data value(s). This must be a
* [Publisher] or another producer adaptable to a
* [Publisher] via [org.springframework.core.ReactiveAdapterRegistry]
* @param T the type of values to be produced
* @author Sebastien Deleuze
* @since 5.2
*/
inline fun RSocketRequester.RequestSpec.dataWithType(producer: Any): RSocketRequester.RetrieveSpec =
data(producer, object : ParameterizedTypeReference() {})
/**
* Extension for [RSocketRequester.RequestSpec.data] providing a `dataWithType(Publisher)`
* variant leveraging Kotlin reified type parameters. This extension is not subject to type
* erasure and retains actual generic type arguments.
* @param publisher the source of payload data value(s)
* @param T the type of values to be produced
* @author Sebastien Deleuze
* @since 5.2
*/
inline fun RSocketRequester.RequestSpec.dataWithType(publisher: Publisher): RSocketRequester.RetrieveSpec =
data(publisher, object : ParameterizedTypeReference() {})
/**
* Extension for [RSocketRequester.RequestSpec.data] providing a `dataWithType(Flow)`
* variant leveraging Kotlin reified type parameters. This extension is not subject to type
* erasure and retains actual generic type arguments.
* @param flow the [Flow] to write to the request
* @param T the source of payload data value(s)
* @author Sebastien Deleuze
* @since 5.2
*/
inline fun RSocketRequester.RequestSpec.dataWithType(flow: Flow): RSocketRequester.RetrieveSpec =
data(flow, object : ParameterizedTypeReference() {})
/**
* Coroutines variant of [RSocketRequester.RetrieveSpec.send].
*
* @author Sebastien Deleuze
* @since 5.2
*/
suspend fun RSocketRequester.RetrieveSpec.sendAndAwait() {
send().awaitFirstOrNull()
}
/**
* Coroutines variant of [RSocketRequester.RetrieveSpec.retrieveMono].
*
* @author Sebastien Deleuze
* @since 5.2
*/
suspend inline fun RSocketRequester.RetrieveSpec.retrieveAndAwait(): T =
retrieveMono(object : ParameterizedTypeReference() {}).awaitSingle()
/**
* Nullable coroutines variant of [RSocketRequester.RetrieveSpec.retrieveMono].
*
* @author Sebastien Deleuze
* @since 5.2.1
*/
suspend inline fun RSocketRequester.RetrieveSpec.retrieveAndAwaitOrNull(): T? =
retrieveMono(object : ParameterizedTypeReference() {}).awaitFirstOrNull()
/**
* Coroutines variant of [RSocketRequester.RetrieveSpec.retrieveFlux].
*
* @author Sebastien Deleuze
* @since 5.2
*/
inline fun RSocketRequester.RetrieveSpec.retrieveFlow(): Flow =
retrieveFlux(object : ParameterizedTypeReference() {}).asFlow()
/**
* Extension for [RSocketRequester.RetrieveSpec.retrieveMono] providing a `retrieveMono()`
* variant leveraging Kotlin reified type parameters. This extension is not subject to type
* erasure and retains actual generic type arguments.
*
* @author Sebastien Deleuze
* @since 5.2
*/
inline fun RSocketRequester.RetrieveSpec.retrieveMono(): Mono =
retrieveMono(object : ParameterizedTypeReference() {})
/**
* Extension for [RSocketRequester.RetrieveSpec.retrieveFlux] providing a `retrieveFlux()`
* variant leveraging Kotlin reified type parameters. This extension is not subject to type
* erasure and retains actual generic type arguments.
*
* @author Sebastien Deleuze
* @since 5.2
*/
inline fun RSocketRequester.RetrieveSpec.retrieveFlux(): Flux =
retrieveFlux(object : ParameterizedTypeReference() {})