Automorph
API
Generated with
Automorph/automorph/Default

Default

automorph.Default
object Default

Default component constructors.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Default.type

Members list

Type members

Types

type Effect[T] = Future[T]

Default effect type.

Default effect type.

Attributes

Inherited types

type Adapter = HttpHandler

Endpoint adapter type.

Endpoint adapter type.

Attributes

Inherited from:
DefaultTransport (hidden)
type ClientContext = Context

Request context type.

Request context type.

Attributes

Inherited from:
DefaultTransport (hidden)
type Codec = CirceJsonCodec

Default message codec plugin type.

Default message codec plugin type.

Attributes

Inherited from:
DefaultRpcProtocol (hidden)
type Node = Node

Default message node type.

Default message node type.

Attributes

Inherited from:
DefaultRpcProtocol (hidden)
type ServerContext = Context

Request context type.

Request context type.

Attributes

Inherited from:
DefaultTransport (hidden)

Value members

Concrete methods

def clientTransport(url: URI, method: HttpMethod)(implicit executionContext: ExecutionContext): HttpClient[Effect]

Creates a standard JRE HTTP & WebSocket client transport plugin with 'Future' as an effect type.

Creates a standard JRE HTTP & WebSocket client transport plugin with 'Future' as an effect type.

Value parameters

executionContext

execution context

method

HTTP request method

url

HTTP endpoint URL

Attributes

Returns

client transport plugin

See also
def effectSystem(implicit executionContext: ExecutionContext): AsyncEffectSystem[Effect]

Creates an asynchronous effect system plugin with 'Future' as an effect type.

Creates an asynchronous effect system plugin with 'Future' as an effect type.

Attributes

Returns

asynchronous effect system plugin

See also
def endpointTransport(mapException: Throwable => Int)(implicit executionContext: ExecutionContext): UndertowHttpEndpoint[Effect]

Creates an Undertow RPC over HTTP & WebSocket endpoint transport plugin with 'Future' as an effect type.

Creates an Undertow RPC over HTTP & WebSocket endpoint transport plugin with 'Future' as an effect type.

Value parameters

executionContext

execution context

mapException

maps an exception to a corresponding HTTP status code

Attributes

Returns

endpoint transport plugin

See also
def rpcClient(url: URI, method: HttpMethod)(implicit executionContext: ExecutionContext): RpcClient[Node, Codec, Effect, ClientContext]

Creates a standard JRE JSON-RPC over HTTP & WebSocket client using default RPC protocol with 'Future' as an effect type.

Creates a standard JRE JSON-RPC over HTTP & WebSocket client using default RPC protocol with 'Future' as an effect type.

The client can be used to perform type-safe remote API calls or send one-way messages.

Value parameters

executionContext

execution context

method

HTTP request method

url

HTTP endpoint URL

Attributes

Returns

asynchronous RPC client

See also
def rpcEndpoint(mapException: Throwable => Int)(implicit executionContext: ExecutionContext): RpcEndpoint[Node, Codec, Effect, ServerContext, Adapter]

Creates an Undertow RPC over HTTP endpoint using default RPC protocol with 'Future' as an effect type.

Creates an Undertow RPC over HTTP endpoint using default RPC protocol with 'Future' as an effect type.

The endpoint can be integrated into an existing server to receive remote API requests using specific transport protocol and invoke bound API methods to process them.

Value parameters

executionContext

execution context

mapException

maps an exception to a corresponding HTTP status code

Attributes

Returns

RPC endpoint

See also
def rpcServer(port: Int, path: String, methods: Iterable[HttpMethod], webSocket: Boolean, mapException: Throwable => Int, builder: Builder)(implicit executionContext: ExecutionContext): RpcServer[Node, Codec, Effect, ServerContext]

Creates an Undertow JSON-RPC server over HTTP & WebSocket using default RPC protocol with 'Future' as an effect type.

Creates an Undertow JSON-RPC server over HTTP & WebSocket using default RPC protocol with 'Future' as an effect type.

The server can be used to serve remote API requests and invoke bound API methods to process them.

Value parameters

executionContext

execution context

mapException

maps an exception to a corresponding HTTP status code

methods

allowed HTTP request methods (default: any)

path

HTTP URL path (default: /)

port

port to listen on for HTTP connections

webSocket

both HTTP and WebSocket protocols enabled if true, HTTP only if false

Attributes

Returns

asynchronous RPC server

See also
def serverTransport(port: Int, path: String, methods: Iterable[HttpMethod], webSocket: Boolean, mapException: Throwable => Int, builder: Builder)(implicit executionContext: ExecutionContext): UndertowServer[Effect]

Creates an Undertow RPC over HTTP & WebSocket server transport plugin with 'Future' as an effect type.

Creates an Undertow RPC over HTTP & WebSocket server transport plugin with 'Future' as an effect type.

Value parameters

builder

Undertow web server builder

executionContext

execution context

mapException

maps an exception to a corresponding HTTP status code

methods

allowed HTTP request methods (default: any)

path

HTTP URL path (default: /)

port

port to listen on for HTTP connections

webSocket

both HTTP and WebSocket protocols enabled if true, HTTP only if false

Attributes

Returns

server transport plugin

See also

Inherited methods

def clientTransportCustom[EffectType[_]](effectSystem: EffectSystem[EffectType], url: URI, method: HttpMethod): HttpClient[EffectType]

Creates a standard JRE HTTP & WebSocket client transport protocol plugin with specified effect system plugin.

Creates a standard JRE HTTP & WebSocket client transport protocol plugin with specified effect system plugin.

Type parameters

EffectType

effect type

Value parameters

effectSystem

effect system plugin

method

HTTP request method

url

HTTP endpoint URL

Attributes

Returns

client transport protocol plugin

See also
Inherited from:
DefaultTransport (hidden)
def endpointTransportCustom[EffectType[_]](effectSystem: EffectSystem[EffectType], mapException: Throwable => Int): UndertowHttpEndpoint[EffectType]

Creates an Undertow RPC over HTTP & WebSocket endpoint transport plugin with specified effect system.

Creates an Undertow RPC over HTTP & WebSocket endpoint transport plugin with specified effect system.

Value parameters

effectSystem

effect system plugin

mapException

maps an exception to a corresponding HTTP status code

Attributes

Returns

endpoint transport plugin

See also
Inherited from:
DefaultTransport (hidden)
def messageCodec: Codec

Creates a Circe JSON message codec plugin.

Creates a Circe JSON message codec plugin.

Attributes

Returns

message codec plugin

See also
Inherited from:
DefaultRpcProtocol (hidden)
def rpcClientCustom[EffectType[_]](effectSystem: EffectSystem[EffectType], url: URI, method: HttpMethod): RpcClient[Node, Codec, EffectType, ClientContext]

Creates a standard JRE JSON-RPC over HTTP & WebSocket client using default RPC protocol with specified effect system plugin.

Creates a standard JRE JSON-RPC over HTTP & WebSocket client using default RPC protocol with specified effect system plugin.

The client can be used to perform type-safe remote API calls or send one-way messages.

Type parameters

EffectType

effect type

Value parameters

effectSystem

effect system plugin

method

HTTP request method

url

HTTP endpoint URL

Attributes

Returns

RPC client

See also
Inherited from:
DefaultTransport (hidden)
def rpcEndpointCustom[EffectType[_]](effectSystem: EffectSystem[EffectType], mapException: Throwable => Int): RpcEndpoint[Node, Codec, EffectType, ServerContext, Adapter]

Creates an Undertow RPC over HTTP endpoint using default RPC protocol with specified effect system.

Creates an Undertow RPC over HTTP endpoint using default RPC protocol with specified effect system.

The endpoint can be integrated into an existing server to receive remote API requests using specific transport protocol and invoke bound API methods to process them.

Type parameters

EffectType

effect type

Value parameters

effectSystem

effect system plugin

mapException

maps an exception to a corresponding HTTP status code

Attributes

Returns

RPC endpoint

See also
Inherited from:
DefaultTransport (hidden)
inline def rpcProtocol[NodeType, CodecType <: MessageCodec[NodeType], Context](messageCodec: CodecType): JsonRpcProtocol[NodeType, CodecType, Context]

Creates a default JSON-RPC protocol plugin with specified message codec plugin.

Creates a default JSON-RPC protocol plugin with specified message codec plugin.

Type parameters

CodecType

message codec plugin type

Context

RPC message context type

NodeType

message node type

Value parameters

messageCodec

message codec plugin

Attributes

Returns

RPC protocol plugin

See also
Inherited from:
DefaultRpcProtocol (hidden)
def rpcProtocol[Context]: JsonRpcProtocol[Node, Codec, Context]

Creates a default JSON-RPC protocol plugin.

Creates a default JSON-RPC protocol plugin.

Type parameters

Context

RPC message context type

Attributes

Returns

RPC protocol plugin

See also
Inherited from:
DefaultRpcProtocol (hidden)
def rpcServerCustom[EffectType[_]](effectSystem: EffectSystem[EffectType], port: Int, path: String, methods: Iterable[HttpMethod], webSocket: Boolean, mapException: Throwable => Int, builder: Builder): RpcServer[Node, Codec, EffectType, ServerContext]

Creates an Undertow RPC over HTTP & WebSocket server using default RPC protocol with specified effect system.

Creates an Undertow RPC over HTTP & WebSocket server using default RPC protocol with specified effect system.

The server can be used to serve remote API requests and invoke bound API methods to process them.

Type parameters

EffectType

effect type

Value parameters

builder

Undertow web server builder

effectSystem

effect system plugin

mapException

maps an exception to a corresponding HTTP status code

methods

allowed HTTP request methods (default: any)

path

HTTP URL path (default: /)

port

port to listen on for HTTP connections

webSocket

both HTTP and WebSocket protocols enabled if true, HTTP only if false

Attributes

Returns

RPC server

See also
Inherited from:
DefaultTransport (hidden)
def serverTransportCustom[EffectType[_]](effectSystem: EffectSystem[EffectType], port: Int, path: String, methods: Iterable[HttpMethod], webSocket: Boolean, mapException: Throwable => Int, builder: Builder): UndertowServer[EffectType]

Creates an Undertow RPC over HTTP & WebSocket server transport protocol plugin with specified effect system.

Creates an Undertow RPC over HTTP & WebSocket server transport protocol plugin with specified effect system.

Type parameters

EffectType

effect type

Value parameters

builder

Undertow web server builder

effectSystem

effect system plugin

mapException

maps an exception to a corresponding HTTP status code

methods

allowed HTTP request methods (default: any)

path

HTTP URL path (default: /)

port

port to listen on for HTTP connections

webSocket

both HTTP and WebSocket protocols enabled if true, HTTP only if false

Attributes

Returns

server transport protocol plugin

See also
Inherited from:
DefaultTransport (hidden)
Generated with