Object

play.socketio.scaladsl

SocketIOEventCodec

Related Doc: package scaladsl

Permalink

object SocketIOEventCodec

DSL for creating a codec for socket.io.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SocketIOEventCodec
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type SocketIOEventDecoder[+T] = (SocketIOEvent) ⇒ T

    Permalink

    Decoder type for decoding a single event.

    Decoder type for decoding a single event.

    The decoder is simply a function, which allows it to be composed using the andThen and compose functions.

  2. type SocketIOEventEncoder[-T] = (T) ⇒ SocketIOEvent

    Permalink

    Encoder type for encoding a single event.

    Encoder type for encoding a single event.

    The encoder is simply a function, which allows it to be composed using the andThen and compose functions.

  3. type SocketIOEventsDecoder[+T] = PartialFunction[SocketIOEvent, T]

    Permalink

    Decoder type for decoding multiple events.

    Decoder type for decoding multiple events.

    The decoder is simply a partial function, which allows decoders to easily by composed together using orElse.

  4. type SocketIOEventsEncoder[-T] = PartialFunction[T, SocketIOEvent]

    Permalink

    Encoder type for encoding multiple events.

    Encoder type for encoding multiple events.

    The encoder is simply a partial function, which allows encoders to easily by composed together using orElse.

  5. implicit class SocketIOSingleArgDecoderBuilder[T] extends AnyRef

    Permalink

    Implicit conversion to enrich socket io decoders for composition.

  6. implicit class SocketIOSingleArgEncoderBuilder[T] extends AnyRef

    Permalink

    Implicit conversion to enrich socket io encoders for composition.

  7. implicit class SocketIOThreeArgDecoderBuilder[T1, T2, T3] extends AnyRef

    Permalink

    Implicit conversion to enrich socket io decoders for composition.

  8. implicit class SocketIOThreeArgEncoderBuilder[T1, T2, T3] extends AnyRef

    Permalink

    Implicit conversion to enrich socket io encoders for composition.

  9. implicit class SocketIOTwoArgDecoderBuilder[T1, T2] extends AnyRef

    Permalink

    Implicit conversion to enrich socket io decoders for composition.

  10. implicit class SocketIOTwoArgEncoderBuilder[T1, T2] extends AnyRef

    Permalink

    Implicit conversion to enrich socket io encoders for composition.

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. final def asInstanceOf[T0]: T0

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def decodeByName[T](decoders: PartialFunction[String, SocketIOEventDecoder[T]]): SocketIOEventsDecoder[T]

    Permalink

    Create a socket.io events decoder that decodes events by event name.

    Create a socket.io events decoder that decodes events by event name.

    For example:

    val chatDecoder = decodeByName { case "chat message" => decodeJson[String] }

  7. def decodeBytes: SocketIOArgDecoder[ByteString]

    Permalink

    Create a socket.io decoder that decodes a single argument as binary.

  8. def decodeJson[T](implicit arg0: Reads[T]): SocketIOArgDecoder[T]

    Permalink

    Create a socket.io decoder that decodes a single argument as JSON, to the given type T.

  9. def decodeNoArgs: SocketIOArgsDecoder[NotUsed]

    Permalink

    Create a socket.io decoder that decodes no arguments.

  10. def encodeByType[T](encoders: PartialFunction[T, (String, SocketIOEventEncoder[_ <: T])]): SocketIOEventsEncoder[T]

    Permalink

    Create a socket.io events encoder that encodes events by type.

    Create a socket.io events encoder that encodes events by type.

    The function should return a tuple of the event name and the encoder to use for the event.

    For example:

    val chatEncoder = encodeByName[String] { case _: String => "chat message" -> encodeJson[String] }

  11. def encodeBytes: SocketIOArgEncoder[ByteString]

    Permalink

    Encode a single ByteString argument to binary.

  12. def encodeJson[T](implicit arg0: Writes[T]): SocketIOArgEncoder[T]

    Permalink

    Encode a single argument to JSON from the given type T.

  13. def encodeNoArgs: SocketIOArgsEncoder[NotUsed]

    Permalink

    Encode no arguments.

  14. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

    Permalink
    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean

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

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

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

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

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

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped