RpcProtocol

automorph.spi.RpcProtocol

Remote procedure call protocol plugin.

Enables use of a specific RPC protocol.

The underlying RPC protocol must support remote function invocation.

Type parameters

Codec

message codec plugin type

Context

RPC message context type

Node

message node type

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class JsonRpcProtocol[Node, Codec, Context]
class WebRpcProtocol[Node, Codec, Context]

Members list

Type members

Types

type Metadata

Protocol-specific RPC message metadata.

Protocol-specific RPC message metadata.

Attributes

Value members

Abstract methods

def apiSchemas: Seq[ApiSchema[Node]]

RPC API schema operations.

RPC API schema operations.

Attributes

Creates an RPC request.

Creates an RPC request.

Value parameters

arguments

named arguments

function

invoked function name

requestContext

request context

requestId

request correlation identifier

responseRequired

true if the request mandates a response, false if there should be no response

Attributes

Returns

RPC request

Creates an RPC response.

Creates an RPC response.

Value parameters

requestMetadata

corresponding RPC request metadata

result

RPC response result

Attributes

Returns

RPC response

def name: String

Protocol name.

Protocol name.

Attributes

Parses an RPC request.

Parses an RPC request.

Value parameters

requestBody

RPC request message body

requestContext

request context

requestId

request correlation identifier

Attributes

Returns

RPC request if the message is valid or RPC error if the message is invalid

Parses an RPC response.

Parses an RPC response.

Value parameters

responseBody

RPC response message body

responseContext

response context

Attributes

Returns

RPC response if the message is valid or RPC error if the message is invalid

Abstract fields

val messageCodec: Codec

Message codec plugin.

Message codec plugin.

Attributes