Qpid
  1. Qpid
  2. QPID-3679

Documentation for JMS prefetch could use some correction and amplification

    Details

    • Type: Bug Bug
    • Status: Resolved
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 0.12
    • Fix Version/s: 0.15
    • Component/s: Documentation, Java Client
    • Labels:
      None

      Description

      (1) the documentation states that maxprefetch controls the 'maximum number of pre-fetched messages per destination'. However this is not strictly correct, it is the prefetch per consumer (if you had multiple consumers on the same destination they would each have that amount of prefetch).

      (2) there is no mention of the capacity option in the address (which admittedly is only supported by the JMS client ta this point)

      1. prefetch_doc.patch
        1.0 kB
        Praveen Murugesan

        Activity

        Gordon Sim created issue -
        Hide
        Praveen Murugesan added a comment -

        A small doc update to fix the issue pointed out by Gordon.

        Show
        Praveen Murugesan added a comment - A small doc update to fix the issue pointed out by Gordon.
        Praveen Murugesan made changes -
        Field Original Value New Value
        Attachment prefetch_doc.patch [ 12514837 ]
        Hide
        Praveen Murugesan added a comment -

        I'm not quite sure, if there is an option called "capacity" in the address string. I am not able to find one digging into AMQConnectionURL (perhaps something changed?).

        I've added a patch to add more information about the maxprefetch option

        Show
        Praveen Murugesan added a comment - I'm not quite sure, if there is an option called "capacity" in the address string. I am not able to find one digging into AMQConnectionURL (perhaps something changed?). I've added a patch to add more information about the maxprefetch option
        Hide
        Robbie Gemmell added a comment -

        I have split the 'capacity' documentation issue out into a seprate JIRA, QPID-3856, to allow progressing the prefetch documentation via this JIRA.

        Show
        Robbie Gemmell added a comment - I have split the 'capacity' documentation issue out into a seprate JIRA, QPID-3856 , to allow progressing the prefetch documentation via this JIRA.
        Hide
        Robbie Gemmell added a comment -

        Praveen, I have applied your patch with some updates: I changed 'number' to 'integer', and removed the section describing the JVM system property and instead cross referenced with the existing documentation for that.

        Show
        Robbie Gemmell added a comment - Praveen, I have applied your patch with some updates: I changed 'number' to 'integer', and removed the section describing the JVM system property and instead cross referenced with the existing documentation for that.
        Robbie Gemmell made changes -
        Status Open [ 1 ] Resolved [ 5 ]
        Assignee Robbie Gemmell [ gemmellr ]
        Fix Version/s 0.15 [ 12319043 ]
        Resolution Fixed [ 1 ]
        Hide
        Robbie Gemmell added a comment -

        Also meant to say, the change isnt published yet on the site. I cant currently generate all of the docs and dont want to just publish some of it so I will wait until I can. It will certianly be put up before the release itself goes out though (and I'm intending to get auto-publication running at some point, because its annoying haivng to do it manually ).

        Show
        Robbie Gemmell added a comment - Also meant to say, the change isnt published yet on the site. I cant currently generate all of the docs and dont want to just publish some of it so I will wait until I can. It will certianly be put up before the release itself goes out though (and I'm intending to get auto-publication running at some point, because its annoying haivng to do it manually ).
        Hide
        Praveen Murugesan added a comment -

        Saw the commit it looks great! Nice work.

        Yep auto generation and auto push of the current changes to the website will be great.

        Show
        Praveen Murugesan added a comment - Saw the commit it looks great! Nice work. Yep auto generation and auto push of the current changes to the website will be great.

          People

          • Assignee:
            Robbie Gemmell
            Reporter:
            Gordon Sim
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development