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.

Sign up for GitHub

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

[fix][client] Fix client erroneous code comments #19915

Merged
merged 3 commits into from
Mar 29, 2023
Merged

[fix][client] Fix client erroneous code comments #19915

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6db19e9
[fix][client] Fix client erroneous code comments
crossoverJie Mar 24, 2023
2f15f6e
[fix][client] Fix client erroneous code comments
crossoverJie Mar 24, 2023
7c42d50
tidy comments and fix codestyle violations
tisonkun Mar 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 16 additions & 13 deletions pulsar-client-api/src/main/java/org/apache/pulsar/client/api/ClientBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,35 +227,38 @@ ClientBuilder authentication(String authPluginClassName, Map<String, String> aut
/**
* Set lookup timeout <i>(default: matches operation timeout)</i>
*
* Lookup operations have a different load pattern to other operations. They can be handled by any broker, are not
* proportional to throughput, and are harmless to retry. Given this, it makes sense to allow them to retry longer
* than normal operation, especially if they experience a timeout.
* <p>
* Lookup operations have a different load pattern to other operations.
* They can be handled by any broker, are not proportional to throughput,
* and are harmless to retry. Given this, it makes sense to allow them to
* retry longer than normal operation, especially if they experience a timeout.
*
* By default this is set to match operation timeout. This is to maintain legacy behaviour. However, in practice
* it should be set to 5-10x the operation timeout.
* <p>
* By default, this is set to match operation timeout. This is to maintain legacy behaviour.
* However, in practice it should be set to 5-10x the operation timeout.
*
* @param lookupTimeout
* lookup timeout
* @param unit
* time unit for {@code lookupTimeout}
* @param lookupTimeout lookup timeout
* @param unit time unit for {@code lookupTimeout}
* @return the client builder instance
*/
ClientBuilder lookupTimeout(int lookupTimeout, TimeUnit unit);

/**
* Set the number of threads to be used for handling connections to brokers <i>(default: 1 thread)</i>.
* Set the number of threads to be used for handling connections to brokers
* <i>(default: Runtime.getRuntime().availableProcessors())</i>.
*
* @param numIoThreads the number of IO threads
* @return the client builder instance
*/
ClientBuilder ioThreads(int numIoThreads);

/**
* Set the number of threads to be used for message listeners <i>(default: 1 thread)</i>.
* Set the number of threads to be used for message listeners
* <i>(default: Runtime.getRuntime().availableProcessors())</i>.
*
* <p>The listener thread pool is shared across all the consumers and readers that are
* using a "listener" model to get messages. For a given consumer, the listener will be
* always invoked from the same thread, to ensure ordering.
* using a "listener" model to get messages. For a given consumer, the listener will
* always be invoked from the same thread, to ensure ordering.
*
* @param numListenerThreads the number of listener threads
* @return the client builder instance
Expand Down