bricks v0.1.0 Bricks.Connector behaviour View Source

A struct, behaviour and functions for working with Socket Connectors

Link to this section Summary

A function which borrows a Socket

state()

State passed to the underlying Connector

t()

A Socket Connector

Attempts to create a connected Socket with the provided Connector

Calls the provided function with a Socket leased from the provided pool

Creates a new Connector from a callback module and a connector object

Create a Socket according to the configuration state

lessee() :: (Bricks.Socket.t() -> {:ok, term()} | {:error, term()})

A function which borrows a Socket

state() :: term()

State passed to the underlying Connector

t() :: %Bricks.Connector{connector: term(), module: atom()}

A Socket Connector

connect(connector)

connect(t()) :: {:ok, Bricks.Socket.t()} | {:error, term()}

Attempts to create a connected Socket with the provided Connector

lease(conn, fun)

lease(t(), lessee()) :: {:error, term()} | term()

Calls the provided function with a Socket leased from the provided pool

Returns the socket to the pool or burns it, depending on the return of the provided function.

In the event of error, burns the socket

new(module, connector)

new(atom(), term()) :: t()

Creates a new Connector from a callback module and a connector object

connect(state)

connect(state()) :: {:ok, Bricks.Socket.t()} | {:error, term()}

Create a Socket according to the configuration state