Trait

com.avsystem.commons.rpc

ProcedureRPCFramework

Related Doc: package rpc

Permalink

trait ProcedureRPCFramework extends RPCFramework

Mix in this trait into your RPC framework to support remote procedures, i.e. fire-and-forget methods with Unit return type.

Linear Supertypes
RPCFramework, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ProcedureRPCFramework
  2. RPCFramework
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type AsRawRPC[RealRPC] = AsRaw[RawRPC, RealRPC]

    Permalink
    Definition Classes
    RPCFramework
  2. type AsRawRealRPC[RealRPC] = AsRawReal[RawRPC, RealRPC]

    Permalink
    Definition Classes
    RPCFramework
  3. type AsRealRPC[RealRPC] = AsReal[RawRPC, RealRPC]

    Permalink
    Definition Classes
    RPCFramework
  4. trait BaseFullRPCInfo[RealRPC] extends AnyRef

    Permalink

    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
  5. trait BaseRawRpcCompanion extends RawRpcCompanion[RawRPC]

    Permalink
    Definition Classes
    RPCFramework
  6. abstract type FullRPCInfo[RealRPC] <: BaseFullRPCInfo[RealRPC]

    Permalink

    This type must be defined as trait or class by an RPCFramework in order to be able to use it's RPCCompanion.

    This type must be defined as trait or class by an RPCFramework in order to be able to use it's RPCCompanion. The fact that every RPCFramework may define its own trait or class for FullRPCInfo helps ScalaJS DCE distinguish between instances of AsRawRPC, AsRealRPC and RPCMetadata for different frameworks and to get rid of unused instances.

    Definition Classes
    RPCFramework
    Example:
    1. object SomeRPCFramework extends RPCFramework {
        abstract class FullRPCInfo[RealRPC] extends BaseFullRPCInfo[RealRPC]
        ...
      }
  7. case class ParamMetadata[T](name: String, annotations: List[MetadataAnnotation], typeMetadata: ParamTypeMetadata[T]) extends TypedMetadata[T] with Product with Serializable

    Permalink
    Definition Classes
    RPCFramework
  8. abstract type ParamTypeMetadata[T]

    Permalink
    Definition Classes
    RPCFramework
  9. trait ProcedureRawRPC extends AnyRef

    Permalink
  10. case class ProcedureSignature(name: String, paramMetadata: List[ProcedureRPCFramework.ParamMetadata[_]], annotations: List[MetadataAnnotation]) extends Signature with TypedMetadata[Unit] with Product with Serializable

    Permalink
  11. abstract class RPCCompanion[RealRPC] extends AnyRef

    Permalink

    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]
  12. abstract type RPCMetadata[RealRPC]

    Permalink
    Definition Classes
    RPCFramework
  13. case class RawInvocation(rpcName: String, args: List[RawValue]) extends Product with Serializable

    Permalink
    Definition Classes
    RPCFramework
  14. abstract type RawRPC <: ProcedureRawRPC

    Permalink
    Definition Classes
    ProcedureRPCFrameworkRPCFramework
  15. abstract type RawValue

    Permalink
    Definition Classes
    RPCFramework
  16. abstract type Reader[T]

    Permalink
    Definition Classes
    RPCFramework
  17. abstract type ResultTypeMetadata[T]

    Permalink
    Definition Classes
    RPCFramework
  18. trait Signature extends AnyRef

    Permalink
    Definition Classes
    RPCFramework
  19. abstract type Writer[T]

    Permalink
    Definition Classes
    RPCFramework

Abstract Value Members

  1. abstract val RPCMetadata: RpcMetadataCompanion[RPCMetadata]

    Permalink
    Definition Classes
    RPCFramework
  2. abstract val RawRPC: BaseRawRpcCompanion

    Permalink
    Definition Classes
    RPCFramework
  3. abstract def read[T](raw: RawValue)(implicit arg0: Reader[T]): T

    Permalink
    Definition Classes
    RPCFramework
  4. abstract def write[T](value: T)(implicit arg0: Writer[T]): RawValue

    Permalink
    Definition Classes
    RPCFramework

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. object AsRawRPC

    Permalink
    Definition Classes
    RPCFramework
  5. object AsRawRealRPC

    Permalink
    Definition Classes
    RPCFramework
  6. object AsRealRPC

    Permalink
    Definition Classes
    RPCFramework
  7. object RawInvocation extends Serializable

    Permalink
    Definition Classes
    RPCFramework
  8. final def asInstanceOf[T0]: T0

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    Any
  16. macro def materializeAsRaw[T]: AsRawRPC[T]

    Permalink

    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
  17. macro def materializeAsRawReal[T]: AsRawRealRPC[T]

    Permalink
    Definition Classes
    RPCFramework
  18. macro def materializeAsReal[T]: AsRealRPC[T]

    Permalink

    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
  19. implicit macro def materializeFullInfo[T]: FullRPCInfo[T]

    Permalink
    Definition Classes
    RPCFramework
  20. macro def materializeMetadata[RealRPC]: RPCMetadata[RealRPC]

    Permalink
    Definition Classes
    RPCFramework
  21. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  24. implicit def readerBasedAsReal[T](implicit arg0: Reader[T]): AsReal[RawValue, T]

    Permalink
    Definition Classes
    RPCFramework
  25. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. implicit def writerBasedAsRaw[T](implicit arg0: Writer[T]): AsRaw[RawValue, T]

    Permalink
    Definition Classes
    RPCFramework

Inherited from RPCFramework

Inherited from AnyRef

Inherited from Any

Ungrouped