t

akka.grpc.scaladsl

StreamResponseRequestBuilder

trait StreamResponseRequestBuilder[Req, Res] extends AnyRef

Request builder for requests providing per call specific metadata capabilities in addition to the client instance default options provided to it through GrpcClientSettings upon creation.

Instances are immutable so can be shared and re-used but are backed by the client that created the instance, so if that is stopped the invocations will fail.

Not for user extension

Annotations
@DoNotInherit() @ApiMayChange()
Source
RequestBuilder.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
ScalaBidirectionalStreamingRequestBuilder, ScalaServerStreamingRequestBuilder
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StreamResponseRequestBuilder
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def addHeader(key: String, value: ByteString): StreamResponseRequestBuilder[Req, Res]

    Add a binary header, the same header key can be added multiple times with different values.

    Add a binary header, the same header key can be added multiple times with different values.

    returns

    A new request builder, that will pass the added header to the server when invoked

  2. abstract def addHeader(key: String, value: String): StreamResponseRequestBuilder[Req, Res]

    Add a header, the value will be ASCII encoded, the same header key can be added multiple times with different values.

    Add a header, the value will be ASCII encoded, the same header key can be added multiple times with different values.

    returns

    A new request builder, that will pass the added header to the server when invoked

  3. abstract def invoke(request: Req): Source[Res, NotUsed]

    Invoke the gRPC method with the additional metadata added

    Invoke the gRPC method with the additional metadata added

    FIXME for streaming response this doesn't really make sense, left it to keep parity with single response but maybe it should go

  4. abstract def invokeWithMetadata(request: Req): Source[Res, Future[GrpcResponseMetadata]]

    Invoke the gRPC method with the additional metadata added and provide access to response metadata