diff options
| author | Matthew Sackman <matthew@lshift.net> | 2010-04-29 16:30:03 +0100 |
|---|---|---|
| committer | Matthew Sackman <matthew@lshift.net> | 2010-04-29 16:30:03 +0100 |
| commit | c308ec2deb0fb47130e23963be3148430cff97bd (patch) | |
| tree | 4df8afa3a386d739acee3f7350e51de25643590a /include | |
| parent | b11da62f6e71cc50eb61319a8b932c7ee64fc822 (diff) | |
| download | rabbitmq-server-c308ec2deb0fb47130e23963be3148430cff97bd.tar.gz | |
More meaningful specs for the backing queue, and removal of duplicated and potentially divergent documentation with the specs
Diffstat (limited to 'include')
| -rw-r--r-- | include/rabbit_backing_queue_spec.hrl | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/include/rabbit_backing_queue_spec.hrl b/include/rabbit_backing_queue_spec.hrl index 7c83bb52..0a0931ea 100644 --- a/include/rabbit_backing_queue_spec.hrl +++ b/include/rabbit_backing_queue_spec.hrl @@ -32,16 +32,20 @@ -type(fetch_result() :: %% Message, IsDelivered, AckTag, Remaining_Len ('empty'|{basic_message(), boolean(), ack(), non_neg_integer()})). +-type(is_durable() :: boolean()). +-type(attempt_recovery() :: boolean()). +-type(purged_msg_count() :: non_neg_integer()). +-type(ack_required() :: boolean()). -spec(start/1 :: ([queue_name()]) -> 'ok'). --spec(init/3 :: (queue_name(), boolean(), boolean()) -> state()). +-spec(init/3 :: (queue_name(), is_durable(), attempt_recovery()) -> state()). -spec(terminate/1 :: (state()) -> state()). -spec(delete_and_terminate/1 :: (state()) -> state()). --spec(purge/1 :: (state()) -> {non_neg_integer(), state()}). +-spec(purge/1 :: (state()) -> {purged_msg_count(), state()}). -spec(publish/2 :: (basic_message(), state()) -> state()). -spec(publish_delivered/3 :: - (boolean(), basic_message(), state()) -> {ack(), state()}). --spec(fetch/2 :: (boolean(), state()) -> {fetch_result(), state()}). + (ack_required(), basic_message(), state()) -> {ack(), state()}). +-spec(fetch/2 :: (ack_required(), state()) -> {fetch_result(), state()}). -spec(ack/2 :: ([ack()], state()) -> state()). -spec(tx_publish/3 :: (txn(), basic_message(), state()) -> state()). -spec(tx_ack/3 :: (txn(), [ack()], state()) -> state()). |