Behaviours: gen_server.
name() = term()
opts() = #{id := supervisor:child_id(), name := name(), url := iodata(), host := iolist(), port := integer(), username := binary(), password := binary(), heartbeat := integer(), virtual_host := binary(), channel_max := integer(), frame_max := integer(), ssl_options := term(), client_properties := list(), retry_sleep := integer(), max_attempts := infinity | integer(), management := #{host := iodata(), port := integer()}}
apply/3 | Calls a function on the underlying amqp connection. |
await/1 | Equivalent to kyu_connection:await(Name, 60000). |
await/2 | Waits for the connection to successfully connect. |
call/2 | Makes a gen_server:call/2 to the connection. |
call/3 | Makes a gen_server:call/3 to the connection. |
cast/2 | Makes a gen_server:cast/2 to the connection. |
child_spec/1 | Returns a connection child spec. |
network/1 | Returns the connection's network params. |
option/2 | Equivalent to kyu_connection:option(Name, Key, undefined). |
option/3 | Returns a value from the connection's options. |
pid/1 | Returns the pid of the underlying amqp connection. |
start_link/1 | Starts a connection. |
status/1 | Returns the up atom if the process is running and has an active connection. |
stop/1 | Gracefully closes the connection. |
subscribe/1 | Subscribes the calling process to events from the connection. |
where/1 | Returns the pid of the connection. |
apply(Name::name(), Function::atom(), Args::list()) -> term()
Calls a function on the underlying amqp connection.
await(Name::name()) -> ok
Equivalent to kyu_connection:await(Name, 60000).
await(Name::name(), Timeout::timeout()) -> ok
Waits for the connection to successfully connect.
call(Name::name(), Request::term()) -> term()
Makes a gen_server:call/2 to the connection.
call(Name::name(), Request::term(), Timeout::timeout()) -> term()
Makes a gen_server:call/3 to the connection.
cast(Name::name(), Request::term()) -> ok
Makes a gen_server:cast/2 to the connection.
child_spec(Opts::opts()) -> supervisor:child_spec()
Returns a connection child spec.
network(Name::name()) -> #amqp_params_network{}
Returns the connection's network params.
option(Name::name(), Key::atom()) -> term()
Equivalent to kyu_connection:option(Name, Key, undefined).
option(Name::name(), Key::atom(), Value::term()) -> term()
Returns a value from the connection's options.
pid(Name::name()) -> pid() | undefined
Returns the pid of the underlying amqp connection.
start_link(Opts::opts()) -> {ok, pid()} | {error, term()}
Starts a connection.
status(Name::name()) -> up | down
Returns the up atom if the process is running and has an active connection.
stop(Name::name()) -> ok
Gracefully closes the connection.
subscribe(Name::name()) -> ok
Subscribes the calling process to events from the connection.
where(Name) -> any()
Returns the pid of the connection. -spec where(Name :: name()) -> pid() | undefined.
Generated by EDoc