Generated with

RpcEndpoint

automorph.RpcEndpoint

See theRpcEndpoint companion object

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.

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
Graph
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Members list

Value members

Concrete methods

Transport layer adapter.

Attributes

Enable or disable automatic provision of service discovery via RPC functions returning bound API schema.

Value parameters

discovery: service discovery enabled

Attributes

Returns: RPC endpoint

Value parameters

filter: filters RPC requests and raises arbitrary errors for non-matching requests

Attributes

Returns: RPC endpoint

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns: a string representation of the object.
Definition Classes: Any

Inherited methods

Creates a copy of this endpoint with added RPC bindings for all public methods of the specified API instance.

The binding generation fails if any public API method has one of the following properties:

does not return the specified effect type
is overloaded
has type parameters
is inline

Bindings API methods using the names identical to already existing bindings replaces the existing bindings with the new bindings.

If the last parameter of bound method is of Context type or returns a context function accepting the Context type the endpoint-supplied ''request context'' is passed to the bound method or the returned context function as its last argument.

Bound API methods are exposed as RPC functions with their names transformed via the mapName function.

Type parameters

Api: API type (only member methods of this type are exposed)

Value parameters

api: API instance
mapName: maps bound API method name to the exposed RPC function names (empty result causes the method not to be exposed)

Attributes

Returns: RPC request endpoint with specified API bindings
Throws: IllegalArgumentException
if invalid public methods are found in the API type
Inherited from:: EndpointBind (hidden)

Creates a copy of this endpoint with added RPC bindings for all public methods of the specified API instance.

The binding generation fails if any public API method has one of the following properties:

does not return the specified effect type
is overloaded
has type parameters
is inline

Bindings API methods using the names identical to already existing bindings replaces * the existing bindings with the new bindings.

Type parameters

Api: API type (only member methods of this type are exposed)

Value parameters

api: API instance

Attributes

Returns: RPC request endpoint with specified API bindings
Throws: IllegalArgumentException
if invalid public methods are found in the API type
Inherited from:: EndpointBind (hidden)

Attributes

Inherited from:: Product

Attributes

Inherited from:: Product

In this article

Generated with