Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Doc] Description for Producer SendAsync Needs Updating #23643

Open
2 tasks done
jasonyunicorn opened this issue Nov 26, 2024 · 4 comments
Open
2 tasks done

[Doc] Description for Producer SendAsync Needs Updating #23643

jasonyunicorn opened this issue Nov 26, 2024 · 4 comments
Labels
doc-required Your PR changes impact docs and you will update later.

Comments

@jasonyunicorn
Copy link

Search before asking

  • I searched in the issues and found nothing similar.

What issue do you find in Pulsar docs?

The description for SendAsync implies that it is a blocking operation, but asynchronous calls should be non-blocking and occur in a background thread.

What is your suggestion?

The SendAsync method in Pulsar is designed to send messages asynchronously, allowing the application to continue processing other tasks without waiting for the send operation to complete. A user-defined callback function is invoked upon the completion of the send operation which can be used to track the success / failure of the send operation.

Any reference?

No response

Are you willing to submit a PR?

  • I'm willing to submit a PR!
@jasonyunicorn jasonyunicorn added the doc-required Your PR changes impact docs and you will update later. label Nov 26, 2024
@jasonyunicorn jasonyunicorn changed the title [Doc] [Doc] Description for Producer SendAsync Needs Updating Nov 26, 2024
@jasonyunicorn
Copy link
Author

Looking at the internalSendAsync implementation, it would only be blocking if DisableBlockIfQueueFull is set to false and the queue is full.

@lhotari
Copy link
Member

lhotari commented Nov 27, 2024

@jasonyunicorn please go ahead with the PR to https://github.com/apache/pulsar-site to update the docs.

@lhotari
Copy link
Member

lhotari commented Nov 27, 2024

In addition, it could be useful to check the javadoc too. That would be a PR to apache/pulsar repository.

@jasonyunicorn
Copy link
Author

@lhotari

In addition, it could be useful to check the javadoc too.

I didn't find much in terms of a function description in the javadocs, but maybe this isn't the right place?

However, there is a good description in the Go docs for SendAsync, which I copied.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-required Your PR changes impact docs and you will update later.
Projects
None yet
Development

No branches or pull requests

2 participants