t

com.avsystem.commons.rpc

StandardRPCFramework

trait StandardRPCFramework extends GetterRPCFramework with FunctionRPCFramework with ProcedureRPCFramework

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StandardRPCFramework
  2. ProcedureRPCFramework
  3. FunctionRPCFramework
  4. GetterRPCFramework
  5. RPCFramework
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. trait FunctionRawRPC extends AnyRef
    Definition Classes
    FunctionRPCFramework
  2. case class FunctionSignature[T](name: String, paramMetadata: List[FunctionRPCFramework.ParamMetadata[_]], annotations: List[MetadataAnnotation], resultTypeMetadata: FunctionRPCFramework.ResultTypeMetadata[T]) extends Signature with TypedMetadata[commons.Future[T]] with Product with Serializable
    Definition Classes
    FunctionRPCFramework
  3. trait GetterRawRPC extends AnyRef
    Definition Classes
    GetterRPCFramework
  4. case class GetterSignature[T](name: String, paramMetadata: List[GetterRPCFramework.ParamMetadata[_]], annotations: List[MetadataAnnotation], resultMetadata: RpcMetadataCompanion.Lazy[T]) extends Signature with TypedMetadata[T] with Product with Serializable
    Definition Classes
    GetterRPCFramework
  5. trait ProcedureRawRPC extends AnyRef
    Definition Classes
    ProcedureRPCFramework
  6. case class ProcedureSignature(name: String, paramMetadata: List[ProcedureRPCFramework.ParamMetadata[_]], annotations: List[MetadataAnnotation]) extends Signature with TypedMetadata[Unit] with Product with Serializable
    Definition Classes
    ProcedureRPCFramework
  7. trait BaseFullRPCInfo[RealRPC] extends AnyRef

    Base trait for traits or classes "implementing" FullRPCInfo in various RPC frameworks.

    Base trait for traits or classes "implementing" FullRPCInfo in various RPC frameworks. Having a separate subtrait/subclass for every framework is beneficial for ScalaJS DCE.

    Definition Classes
    RPCFramework
  8. trait BaseRawRpcCompanion extends RawRpcCompanion[RawRPC]
    Definition Classes
    RPCFramework
  9. case class ParamMetadata[T](name: String, annotations: List[MetadataAnnotation], typeMetadata: ParamTypeMetadata[T]) extends TypedMetadata[T] with Product with Serializable
    Definition Classes
    RPCFramework
  10. abstract class RPCCompanion[RealRPC] extends AnyRef

    Convenience abstract class for companion objects of RPC interfaces.

    Convenience abstract class for companion objects of RPC interfaces. Makes sure all three RPC type classes (AsRawRPC, AsRealRPC and RPCMetadata) are macro-materialized for that RPC interface and confines macro materialization to the same compilation unit where the RPC interface is defined. This is a good practice to avoid incremental compilation problems and duplication of macro-generated code in various callsites. In order to be able to use RPCCompanion, the RPC framework must define FullRPCInfo as a trait or class. Additionally, some special wizardry has been employed to make sure that when an RPC interface is a part of shared (cross-compiled) code of a ScalaJS application then ScalaJS optimizer can remove unused instances of macro generated typeclasses.

    Definition Classes
    RPCFramework
    Example: 

    1. object SomeRPCFramework extends StandardRPCFramework { ... }
@RPC trait SomeRPC {
  def doSomething(str: String): Unit
  def callSomething(int: Int): Future[String]
}
object SomeRPC extends SomeRPCFramework.RPCCompanion[SomeRPC]
  11. case class RawInvocation(rpcName: String, args: List[RawValue]) extends Product with Serializable
    Definition Classes
    RPCFramework
  12. trait Signature extends AnyRef
    Definition Classes
    RPCFramework
  13. type AsRawRPC[RealRPC] = AsRaw[RawRPC, RealRPC]
    Definition Classes
    RPCFramework
  14. type AsRawRealRPC[RealRPC] = AsRawReal[RawRPC, RealRPC]
    Definition Classes
    RPCFramework
  15. type AsRealRPC[RealRPC] = AsReal[RawRPC, RealRPC]
    Definition Classes
    RPCFramework
  16. trait FullRPCInfo[T] extends BaseFullRPCInfo[T]
  17. abstract type ParamTypeMetadata[T]
    Definition Classes
    RPCFramework
  18. case class RPCMetadata[T](name: String, annotations: List[MetadataAnnotation], procedureSignatures: Map[String, StandardRPCFramework.ProcedureSignature], functionSignatures: Map[String, StandardRPCFramework.FunctionSignature[_]], getterSignatures: Map[String, StandardRPCFramework.GetterSignature[_]]) extends Product with Serializable
  19. trait RawRPC extends GetterRawRPC with FunctionRawRPC with ProcedureRawRPC
  20. abstract type RawValue
    Definition Classes
    RPCFramework
  21. abstract type Reader[T]
    Definition Classes
    RPCFramework
  22. abstract type ResultTypeMetadata[T]
    Definition Classes
    RPCFramework
  23. abstract type Writer[T]
    Definition Classes
    RPCFramework

Abstract Value Members

  1. abstract def read[T](raw: RawValue)(implicit arg0: Reader[T]): T
    Definition Classes
    RPCFramework
  2. abstract def write[T](value: T)(implicit arg0: Writer[T]): RawValue
    Definition Classes
    RPCFramework

Concrete Value Members

  1. object AsRawRPC
    Definition Classes
    RPCFramework
  2. object AsRawRealRPC
    Definition Classes
    RPCFramework
  3. object AsRealRPC
    Definition Classes
    RPCFramework
  4. object RawInvocation extends Serializable
    Definition Classes
    RPCFramework
  5. macro def materializeAsRaw[T]: AsRawRPC[T]

    Materializes a factory of implementations of RawRPC which translate invocations of its raw methods to invocations of actual methods on rpcImpl.

    Materializes a factory of implementations of RawRPC which translate invocations of its raw methods to invocations of actual methods on rpcImpl. Method arguments and results are serialized and deserialized from/to RawValue using Reader and Writer typeclasses.

    Definition Classes
    RPCFramework
  6. macro def materializeAsRawReal[T]: AsRawRealRPC[T]
    Definition Classes
    RPCFramework
  7. macro def materializeAsReal[T]: AsRealRPC[T]

    Materializes a factory of implementations of T which are proxies that implement all abstract methods of T by forwarding them to rawRpc.

    Materializes a factory of implementations of T which are proxies that implement all abstract methods of T by forwarding them to rawRpc. Method arguments and results are serialized and deserialized from/to RawValue using Reader and Writer typeclasses.

    Definition Classes
    RPCFramework
  8. implicit macro def materializeFullInfo[T]: FullRPCInfo[T]
    Definition Classes
    RPCFramework
  9. macro def materializeMetadata[RealRPC]: RPCMetadata[RealRPC]
    Definition Classes
    RPCFramework
  10. implicit def readerBasedAsReal[T](implicit arg0: Reader[T]): AsReal[RawValue, T]
    Definition Classes
    RPCFramework
  11. implicit def readerBasedFutureAsReal[T](implicit arg0: Reader[T]): AsReal[commons.Future[RawValue], commons.Future[T]]
    Definition Classes
    FunctionRPCFramework
  12. implicit def writerBasedAsRaw[T](implicit arg0: Writer[T]): AsRaw[RawValue, T]
    Definition Classes
    RPCFramework
  13. implicit def writerBasedFutureAsRaw[T](implicit arg0: Writer[T]): AsRaw[commons.Future[RawValue], commons.Future[T]]
    Definition Classes
    FunctionRPCFramework
  14. object RPCMetadata extends RpcMetadataCompanion[RPCMetadata] with Serializable
    Definition Classes
    StandardRPCFramework → RPCFramework
  15. object RawRPC extends BaseRawRpcCompanion
    Definition Classes
    StandardRPCFramework → RPCFramework