Bug 787154 - arguments missing in "Exchange and Queue Arguments" appendix
Summary: arguments missing in "Exchange and Queue Arguments" appendix
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Deadline: 2012-12-07
Product: Red Hat Enterprise MRG
Classification: Red Hat
Component: Messaging_Installation_and_Configuration_Guide
Version: 2.1
Hardware: Unspecified
OS: Unspecified
high
medium
Target Milestone: 2.3
: ---
Assignee: Joshua Wulf
QA Contact: Petr Matousek
URL:
Whiteboard:
Depends On: 709717
Blocks:
TreeView+ depends on / blocked
 
Reported: 2012-02-03 11:07 UTC by Petr Matousek
Modified: 2014-10-19 23:00 UTC (History)
6 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2013-03-13 23:59:25 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Petr Matousek 2012-02-03 11:07:59 UTC
Description of problem:

some arguments are still missing in the list, ie.:

qpid.group_header_key [string] -  Provides the key for the message header that
holds the group identifier value.
qpid.shared_msg_group [0,1] -  Setting this value enforces ordering across
multiple consumers. 

Note: This is probably still not the complete list, Ted would add additional content.

Version-Release number of selected component (if applicable):
revision 2-15

Actual results:
The arguments list for creating queues/exchanges is incomplete

Expected results:
The arguments list for creating queues/exchanges is complete

Comment 2 Joshua Wulf 2012-04-25 12:28:39 UTC
OK, I'll try tagging all topics that contain queue and exchange declaration arguments with a common tag as I go.

Then I'll query for them, and collate them into topic 8380, then circle back with the completed list to ask what's missing.

Comment 6 Cheryn Tan 2012-11-15 09:12:18 UTC
Setting devel conditional NAK -- this bug will be fixed if information is provided by 30 November, otherwise we'll have to push it to the next release. Setting needinfo to Justin, please and thank you!

Comment 9 mick 2012-11-30 15:45:18 UTC
Use this site:
  https://cwiki.apache.org/confluence/display/qpid/Qpid+extensions+to+AMQP
to see explanatory comments on most Queue and Exchange args.


I have gathered all of them here, including some that are not
documented on that page.

I've given the data types for each one, and included explanatory
comments for those few that are not already commented on the
above wiki page.

I also have notes associated with a few of the arguments, when
there's something unusual going on.


NOTE: You may or may not want to not document the queue arg
      'qpid.insert_sequence_numbers'.  The comment in the code
      says that it is not completely ready for prime-time.




EXCHANGE arguments
{
  -------------------------------------------
  NAME: qpid.msg_sequence
  {
    type : bool

    comment: Causes the exchange to insert a sequence number
             in the header of each message, at key "qpidMsgSequence".
  }

  -------------------------------------------
  NAME: qpid.ive
  {
    type : bool
  }

  -------------------------------------------
  NAME: qpid.sequence_counter
  {
    type: int64

    comment: Start qpid.msg_sequence counting at the given number.
  }
}





QUEUE arguments
{
  -------------------------------------------
  NAME: no-local
  {
    type : bool
    note : This one has a hyphen.  Most have underbars.
           Also, this is the only one that does not
           begin with the 'qpid.' prefix.
  }

  -------------------------------------------
  NAME: qpid.alert_count
  {
    type : uint32_t
  }

  -------------------------------------------
  NAME: qpid.alert_repeat_gap
  {
    type : int64_t
  }

  -------------------------------------------
  NAME: qpid.alert_size
  {
    type : int64_t
  }

  -------------------------------------------
  NAME: qpid.auto_delete_timeout
  {
    type : bool
  }

  -------------------------------------------
  NAME: qpid.browse-only
  {
    type : bool
    note : This one has a hyphen.  Most have underbars.
           ( The person who wrote the code for this one was kind of dense. )
  }

  -------------------------------------------
  NAME: qpid.file_count
  {
    type : int
  }

  -------------------------------------------
  NAME: qpid.file_size
  {
    type : int64
  }

  -------------------------------------------
  NAME: qpid.flow_resume_count
  {
    type : uint32_t
  }

  -------------------------------------------
  NAME: qpid.flow_resume_size
  {
    type : uint64_t
  }

  -------------------------------------------
  NAME: qpid.flow_stop_count
  {
    type : uint32_t
  }

  -------------------------------------------
  NAME: qpid.flow_stop_size
  {
    type : uint64_t
  }

  -------------------------------------------
  NAME: qpid.insert_sequence_numbers
  {
    type:   string

    comment
    {
      Feature is not ready for general use as it doesn't
      handle the case where a message is enqueued on more
      than one queue well enough.
    }

    note
    {
      valid values:  "qpid.replication.seqno"
    }
  }

  -------------------------------------------
  NAME: qpid.last_value_queue
  {
    type : bool
  }

  -------------------------------------------
  NAME: qpid.last_value_queue_key
  {
    type : string
  }

  -------------------------------------------
  NAME: qpid.last_value_queue_no_browse
  {
    type : bool
  }

  -------------------------------------------
  NAME: qpid.max_count
  {
    type : uint32_t
  }

  -------------------------------------------
  NAME: qpid.max_size
  {
    type : int64_t
  }

  -------------------------------------------
  NAME: qpid.msg_sequence
  {
    type : bool
  }

  -------------------------------------------
  NAME: qpid.persist_last_node
  {
    type:    bool
    comment: If a cluster has broker failures that reduce it to a
             single node, the queue should make its data persistent.
  }

  -------------------------------------------
  NAME: qpid.policy_type
  {
    type : string
  }

  -------------------------------------------
  NAME: qpid.priorities
  {
    type : size_t
  }

  -------------------------------------------
  NAME: qpid.queue_event_generation
  {
    type : int
    note : valid values: ENQUEUE_ONLY=1 ENQUEUE_AND_DEQUEUE=2
  }

  -------------------------------------------
  NAME: qpid.trace.exclude
  {
    type : string
    note : comma-separated list of messages to exclude
  }

  -------------------------------------------
  NAME: qpid.trace.id
  {
    type : string
  }

}

Comment 11 Joshua Wulf 2012-12-12 05:42:26 UTC
Thanks Mick, I've documented the ones you've given.

On the wiki page are these three marked as "Y" for C++. Should they also go into the list?

x-qpid-maximum-message-size	
x-qpid-maximum-message-count	
x-qpid-minimum-alert-repeat-gap

Comment 12 mick 2012-12-12 14:24:26 UTC
Yes, they are there -- but it looks like they are all aliases for other names.

x-qpid-maximum-message-size     is an alias for qpid.alert_size
x-qpid-maximum-message-count    is an alias for qpid.alert_count
x-qpid-minimum-alert-repeat-gap is an alias for qpid.alert_repeat_gap

Comment 14 Petr Matousek 2013-01-25 13:54:53 UTC
Hi Joshua, just a very minor issue here. You have decided to describe also the aliases mentioned in comment 12,  but you've omitted one (marked on the wiki page with "Y" for C++ as well):

x-qpid-priorities is an alias for qpid.priorities

Comment 16 Cheryn Tan 2013-03-13 23:59:25 UTC
Docs published on https://access.redhat.com/knowledge/docs/Red_Hat_Enterprise_MRG/


Note You need to log in before you can comment on or make changes to this bug.