ScodecSerial

Value Members

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

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. final def ==(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

4. lazy val applicationErrorCodec: Codec[Throwable]

   

   A codec for application errors.

   A codec for application errors.

   Implementations may decide which errors they wish to serialize. By default we only encode a few exceptions from the standard library.

   Definition Classes

   ScodecSerial

5. def apply[Req, Rep](implicit reqCodec: C[Req], repCodec: C[Rep]): com.twitter.finagle.Client[Req, Rep] with com.twitter.finagle.Server[Req, Rep]

   

   Returns an instance of com.twitter.finagle.Client with com.twitter.finagle.Server of concrete serial protocol from Req to Rep.

   Returns an instance of com.twitter.finagle.Client with com.twitter.finagle.Server of concrete serial protocol from Req to Rep.

   val server = Serial[Foo, Bar].serve(...)
   val client = Serial[Foo, Bar].newService(...)

   Req

   the request type

   Rep

   the response type

   reqCodec

   the request codec

   repCodec

   the response codec

   Definition Classes

   Serial

6. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

7. def client[Req, Rep](implicit reqCodec: C[Req], repCodec: C[Rep]): com.twitter.finagle.Client[Req, Rep]

   

   Create a com.twitter.finagle.Client given request and response codecs.

   Create a com.twitter.finagle.Client given request and response codecs.

   Definition Classes

   Serial

8. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

9. lazy val codecErrorCodec: Codec[CodecError]

   

   A codec for encoding errors.

   A codec for encoding errors.

   Because encoding errors are sent over the wire, an implementation needs to specify how to encode them.

   Definition Classes

   ScodecSerial

10. def decodeRep[A](bytes: BitVector)(c: Codec[A]): Try[A]

    

    Decode a result.

    Decode a result.

    An implementation should deserialize the errors returned its io.github.finagle.Serial#encodeRep.

    Definition Classes

    ScodecSerial → Serial

11. def decodeReq[A](bytes: BitVector)(c: Codec[A]): Try[A]

    

    Decode a request.

    Decode a request.

    An implementation should decode io.github.finagle.serial.CodecError and return instances as an error.

    Definition Classes

    ScodecSerial → Serial

12. def encodeRep[A](t: Try[A])(c: Codec[A]): Try[BitVector]

    

    Encode a result.

    Encode a result.

    An implementation should fail with io.github.finagle.serial.CodecError in the event of a encoding error.

    Definition Classes

    ScodecSerial → Serial

13. def encodeReq[A](a: A)(c: Codec[A]): Try[BitVector]

    

    Encode a request.

    Encode a request.

    A "well-behaved" implementation should only fail with instances of io.github.finagle.serial.CodecError; all other errors will result in an com.twitter.finagle.mux.ServerApplicationError being returned.

    Definition Classes

    ScodecSerial → Serial

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

    

    Definition Classes

    AnyRef

15. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

16. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

17. def fromBuf(buf: Buf): BitVector

    

    Convert a com.twitter.io.Buf to this implementation's byte buffer representation.

    Convert a com.twitter.io.Buf to this implementation's byte buffer representation.

    Definition Classes

    ScodecSerial → Serial

18. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

19. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

20. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

21. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

22. final def notify(): Unit

    

    Definition Classes

    AnyRef

23. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

24. def serveFunction[Req, Rep](addr: SocketAddress)(f: (Req) ⇒ Rep)(implicit reqCodec: C[Req], repCodec: C[Rep]): ListeningServer

    

    A convenience method that creates a server from a function.

    A convenience method that creates a server from a function.

    Definition Classes

    Serial

25. def server[Req, Rep](implicit reqCodec: C[Req], repCodec: C[Rep]): com.twitter.finagle.Server[Req, Rep]

    

    Create a com.twitter.finagle.Server given request and response codecs.

    Create a com.twitter.finagle.Server given request and response codecs.

    Definition Classes

    Serial

26. final def synchronized[T0](arg0: ⇒ T0): T0

    

    Definition Classes

    AnyRef

27. def toBuf(bytes: BitVector): Buf

    

    Convert the implementation's representation of a byte buffer to a com.twitter.io.Buf.

    Convert the implementation's representation of a byte buffer to a com.twitter.io.Buf.

    Definition Classes

    ScodecSerial → Serial

28. def toString(): String

    

    Definition Classes

    AnyRef → Any

29. lazy val unhandledApplicationErrorCodec: Codec[ApplicationError]

    

    A codec for "fall-back" errors.

    A codec for "fall-back" errors.

    This will be used if applicationErrorCodec does not successfully encode an application error.

    Definition Classes

    ScodecSerial

30. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

31. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

32. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )