%% The contents of this file are subject to the Mozilla Public License
%% Version 1.1 (the "License"); you may not use this file except in
%% compliance with the License. You may obtain a copy of the License at
%% http://www.mozilla.org/MPL/
%%
%% Software distributed under the License is distributed on an "AS IS"
%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
%% License for the specific language governing rights and limitations
%% under the License.
%%
%% The Original Code is RabbitMQ.
%%
%% The Initial Developer of the Original Code is GoPivotal, Inc.
%% Copyright (c) 2011-2015 Pivotal Software, Inc. All rights reserved.
%%
%% @doc This module is an implementation of the amqp_gen_consumer
%% behaviour and can be used as part of the Consumer parameter when
%% opening AMQP channels.
%%
%%
%% The Consumer parameter for this implementation is {{@module},
%% [ConsumerPid]@}, where ConsumerPid is a process that will receive
%% queue subscription-related messages.
%%
%% This consumer implementation causes the channel to send to the
%% ConsumerPid all basic.consume, basic.consume_ok, basic.cancel,
%% basic.cancel_ok and basic.deliver messages received from the
%% server.
%%
%%
%% In addition, this consumer implementation monitors the ConsumerPid
%% and exits with the same shutdown reason when it dies. 'DOWN'
%% messages from other sources are passed to ConsumerPid.
%%
%% Warning! It is not recommended to rely on a consumer on killing off the
%% channel (through the exit signal). That may cause messages to get lost.
%% Always use amqp_channel:close/{1,3} for a clean shut down.
%%
%% This module has no public functions.
-module(amqp_direct_consumer).
-include("amqp_gen_consumer_spec.hrl").
-behaviour(amqp_gen_consumer).
-export([init/1, handle_consume_ok/3, handle_consume/3, handle_cancel_ok/3,
handle_cancel/2, handle_server_cancel/2,
handle_deliver/3, handle_deliver/4,
handle_info/2, handle_call/3, terminate/2]).
%%---------------------------------------------------------------------------
%% amqp_gen_consumer callbacks
%%---------------------------------------------------------------------------
%% @private
init([ConsumerPid]) ->
erlang:monitor(process, ConsumerPid),
{ok, ConsumerPid}.
%% @private
handle_consume(M, A, C) ->
C ! {M, A},
{ok, C}.
%% @private
handle_consume_ok(M, _, C) ->
C ! M,
{ok, C}.
%% @private
handle_cancel(M, C) ->
C ! M,
{ok, C}.
%% @private
handle_cancel_ok(M, _, C) ->
C ! M,
{ok, C}.
%% @private
handle_server_cancel(M, C) ->
C ! {server_cancel, M},
{ok, C}.
%% @private
handle_deliver(M, A, C) ->
C ! {M, A},
{ok, C}.
handle_deliver(M, A, DeliveryCtx, C) ->
C ! {M, A, DeliveryCtx},
{ok, C}.
%% @private
handle_info({'DOWN', _MRef, process, C, normal}, C) ->
%% The channel was closed.
{ok, C};
handle_info({'DOWN', _MRef, process, C, Info}, C) ->
{error, {consumer_died, Info}, C};
handle_info({'DOWN', MRef, process, Pid, Info}, C) ->
C ! {'DOWN', MRef, process, Pid, Info},
{ok, C}.
%% @private
handle_call(M, A, C) ->
C ! {M, A},
{reply, ok, C}.
%% @private
terminate(_Reason, C) ->
C.