Skip to content

[Protocol] Add guidance to send CloseProducer before sending Producer…#12948

Merged
eolivelli merged 1 commit into
apache:masterfrom
michaeljmarshall:add-note-to-protocol-documentation
Dec 2, 2021
Merged

[Protocol] Add guidance to send CloseProducer before sending Producer…#12948
eolivelli merged 1 commit into
apache:masterfrom
michaeljmarshall:add-note-to-protocol-documentation

Conversation

@michaeljmarshall

Copy link
Copy Markdown
Member

… in case of client side timeout

Motivation

As discussed on the mailing list here, https://lists.apache.org/thread/tko0z4jg0oq0yf931rbow2zf9fq8wjt1, it is most ideal for the client to send a CloseProducer command before sending a subsequent Producer command when the client timeouts out the original Producer request.

This PR updates the protocol documentation. I will submit a PR to update the Java client once this PR is merged.

Modifications

  • Update current docs for protocol
  • Update next docs for protocol

Verifying this change

This is just a change to documentation.

Does this pull request potentially affect one of the following parts:

  • Dependencies (does it add or upgrade a dependency): no
  • The public API: no
  • The schema: no
  • The default values of configurations: no
  • The wire protocol: yes
  • The rest endpoints: no
  • The admin cli options: no
  • Anything that affects deployment: no

Regarding the change to the wire protocol, this is simply an expansion on a currently ambiguous portion of the protocol. I've discussed this change on the mailing list.

Documentation

  • doc

@github-actions github-actions Bot added the doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. label Nov 23, 2021
@Anonymitaet Anonymitaet added this to the 2.10.0 milestone Nov 24, 2021

@Anonymitaet Anonymitaet left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for adding docs! LGTM from a technical writing perspective.

@Anonymitaet

Copy link
Copy Markdown
Member

@codelipenghui can you review it from the technical perspective? Thanks

@lhotari lhotari left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@eolivelli
eolivelli merged commit 316c86d into apache:master Dec 2, 2021
@michaeljmarshall
michaeljmarshall deleted the add-note-to-protocol-documentation branch December 2, 2021 18:10
fxbing pushed a commit to fxbing/pulsar that referenced this pull request Dec 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Your PR contains doc changes, no matter whether the changes are in markdown or code files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants