Automorph
API
Generated with
Automorph/automorph

automorph

package automorph

Members list

Packages

package automorph.client
package automorph.codec
package automorph.handler
package automorph.protocol
package automorph.schema
package automorph.spi
package automorph.system
package automorph.transport

Type members

Classlikes

object Default

Default component constructors.

Default component constructors.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Default.type
final case class RpcCall[Context](function: String, arguments: Seq[Any], context: Context)

RPC call.

RPC call.

Type parameters

Context

RPC message context type

Value parameters

arguments

function arguments

function

function name

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class RpcClient[Node, Codec <: MessageCodec[Node], Effect[_], Context](transport: ClientTransport[Effect, Context], rpcProtocol: RpcProtocol[Node, Codec, Context])

RPC client.

RPC client.

Used to perform type-safe remote API calls or send one-way messages.

Remote APIs can be invoked via proxy instances automatically created from specified API trait or without an API trait by supplying the required type information on invocation.

Type parameters

Codec

message codec plugin type

Context

RPC message context type

Effect

effect type

Node

message node type

Value parameters

rpcProtocol

RPC protocol plugin

transport

client transport protocol plugin

Attributes

Constructor

Creates an RPC client with specified protocol and transport plugins providing corresponding message context type.

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object RpcClient

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
RpcClient.type
final case class RpcEndpoint[Node, Codec <: MessageCodec[Node], Effect[_], Context, Adapter](transport: EndpointTransport[Effect, Context, Adapter], rpcProtocol: RpcProtocol[Node, Codec, Context], handler: RequestHandler[Effect, Context], functions: Seq[RpcFunction])

RPC endpoint.

RPC endpoint.

Used to handle remote API requests as part of an existing server and invoke bound API methods to process them.

Automatically derives remote API bindings for existing API instances.

Type parameters

Adapter

transport layer adapter type

Codec

message codec plugin type

Context

RPC message context type

Effect

effect type

Node

message node type

Value parameters

functions

bound RPC functions

handler

RPC request handler

rpcProtocol

RPC protocol plugin

transport

transport layer transport plugin

Attributes

Constructor

Creates an RPC endpoint with specified protocol and transport plugins supporting corresponding message context type.

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object RpcEndpoint

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed abstract class RpcException(message: String, cause: Throwable) extends RuntimeException

RPC exception.

RPC exception.

Value parameters

cause

error cause

message

error message

Attributes

Companion
object
Supertypes
class RuntimeException
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Show all
Known subtypes
class ServerError
Show all
object RpcException

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class RpcFunction(name: String, parameters: Seq[Parameter], resultType: String, documentation: Option[String])

Remote function descriptor.

Remote function descriptor.

Value parameters

documentation

documentation (Scaladoc)

name

name

parameters

parameters

resultType

result type

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object RpcFunction

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class RpcResult[Result, Context](result: Result, context: Context)

RPC function return type containing both the actual result and RPC response context.

RPC function return type containing both the actual result and RPC response context.

Type parameters

Context

RPC response context type

Result

RPC function result type

Value parameters

context

RPC response context

result

RPC function result

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class RpcServer[Node, Codec <: MessageCodec[Node], Effect[_], Context](transport: ServerTransport[Effect, Context], rpcProtocol: RpcProtocol[Node, Codec, Context], handler: RequestHandler[Effect, Context], functions: Seq[RpcFunction])

RPC server.

RPC server.

Used to serve remote API requests and invoke bound API methods to process them.

Automatically derives remote API bindings for existing API instances.

Type parameters

Codec

message codec plugin type

Context

RPC message context type

Effect

effect type

Node

message node type

Value parameters

functions

bound RPC functions

handler

RPC request handler

rpcProtocol

RPC protocol plugin

transport

server transport protocol plugin

Attributes

Constructor

Creates an RPC server with specified protocol and transport plugins supporting corresponding message context type.

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object RpcServer

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
RpcServer.type
Generated with