Module amqp_rpc_client

Description
Function Index
Function Details

This module allows the simple execution of an asynchronous RPC over AMQP.

Behaviours: gen_server.

Description

This module allows the simple execution of an asynchronous RPC over AMQP. It frees a client programmer of the necessary having to AMQP plumbing. Note that the this module does not handle any data encoding, so it is up to the caller to marshall and unmarshall message payloads accordingly.

Function Index

call/2	Invokes an RPC.
start/2	Starts a new RPC client instance that sends requests to a specified queue.
start_link/2	Starts, and links to, a new RPC client instance that sends requests to a specified queue.
stop/1	Stops an existing RPC client.

Function Details

call/2

call(RpcClient, Payload) -> ok

RpcClient = pid()
Payload = binary()

Invokes an RPC. Note the caller of this function is responsible for encoding the request and decoding the response.

start/2

start(Connection, Queue) -> RpcClient

Connection = pid()
Queue = binary()
RpcClient = pid()

Starts a new RPC client instance that sends requests to a specified queue. This function returns the pid of the RPC client process that can be used to invoke RPCs and stop the client.

start_link/2

start_link(Connection, Queue) -> RpcClient

Connection = pid()
Queue = binary()
RpcClient = pid()

Starts, and links to, a new RPC client instance that sends requests to a specified queue. This function returns the pid of the RPC client process that can be used to invoke RPCs and stop the client.

stop/1

stop(Pid::RpcClient) -> ok

RpcClient = pid()

Stops an existing RPC client.

Generated by EDoc