Trait

com.lightbend.lagom.scaladsl.api.deser

StreamedMessageSerializer

Related Doc: package deser

Permalink

trait StreamedMessageSerializer[Message] extends MessageSerializer[Source[Message, NotUsed], Source[ByteString, NotUsed]]

A streamed message serializer, for streams of messages.

Linear Supertypes
MessageSerializer[Source[Message, NotUsed], Source[ByteString, NotUsed]], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StreamedMessageSerializer
  2. MessageSerializer
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def deserializer(protocol: MessageProtocol): NegotiatedDeserializer[Source[Message, NotUsed], Source[ByteString, NotUsed]]

    Permalink

    Get a deserializer for an entity described by the given request or response protocol.

    Get a deserializer for an entity described by the given request or response protocol.

    protocol

    The protocol of the message request or response associated with the entity.

    returns

    A deserializer for request/response messages.

    Definition Classes
    MessageSerializer
    Annotations
    @throws( ... )
    Exceptions thrown

    UnsupportedMediaType If the deserializer can't deserialize that protocol.

  2. abstract def serializerForRequest: NegotiatedSerializer[Source[Message, NotUsed], Source[ByteString, NotUsed]]

    Permalink

    Get a serializer for a client request.

    Get a serializer for a client request.

    Since a client is the initiator of the request, it simply returns the default serializer for the entity.

    returns

    A serializer for request messages.

    Definition Classes
    MessageSerializer
  3. abstract def serializerForResponse(acceptedMessageProtocols: Seq[MessageProtocol]): NegotiatedSerializer[Source[Message, NotUsed], Source[ByteString, NotUsed]]

    Permalink

    Negotiate a serializer for the response, given the accepted message headers.

    Negotiate a serializer for the response, given the accepted message headers.

    acceptedMessageProtocols

    The accepted message headers is a list of message headers that will be accepted by the client. Any empty values in a message protocol, including the list itself, indicate that any format is acceptable.

    Definition Classes
    MessageSerializer
    Annotations
    @throws( ... )
    Exceptions thrown

    NotAcceptable If the serializer can't meet the requirements of any of the accept headers.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def acceptResponseProtocols: Seq[MessageProtocol]

    Permalink

    The message headers that will be accepted for response serialization.

    The message headers that will be accepted for response serialization.

    Definition Classes
    MessageSerializer
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  13. def isStreamed: Boolean

    Permalink

    Whether this serializer is a streamed serializer or not.

    Whether this serializer is a streamed serializer or not.

    returns

    Whether this is a streamed serializer.

    Definition Classes
    StreamedMessageSerializerMessageSerializer
  14. def isUsed: Boolean

    Permalink

    Whether this serializer serializes values that are used or not.

    Whether this serializer serializes values that are used or not.

    If false, it means this serializer is for an empty request/response, eg, they use the akka.NotUsed type.

    returns

    Whether the values this serializer serializes are used.

    Definition Classes
    MessageSerializer
  15. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  19. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  20. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from MessageSerializer[Source[Message, NotUsed], Source[ByteString, NotUsed]]

Inherited from AnyRef

Inherited from Any

Ungrouped