Skip to content

IModel.WaitForConfirmsOrDie* methods don't document that they close #1234

@lukealbao

Description

@lukealbao

Hi there, thanks for this library.

I suppose many people could infer from the name (OrDie) that these methods close the channel. I however assumed that the documentation was clear enough to be complete:

Waits until all messages published since the last call have
been ack'd by the broker.  If a nack is received or the timeout
elapses, throws an OperationInterrupedException exception immediately.

I consider it extra dangerous because failures are rare enough that automated testing doesn't catch it, as ours did not. With long-lived channels, the first nack caused all subsequent publish attempts to fail.

I'd be happy to submit a PR, but I'm unclear on (1) if this is actually part of the interface or if it just so happens that the implementations do this, and (2) how would one submit a PR for documentation that would apply to all supported versions/branches? (We are using 4.x. I just noticed that the copied doc above also describes the wrong exception type; that's from the 4.x branch.)

Thank you again!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions