Dhairya-007 opened a new pull request, #29492:
URL: https://github.com/apache/camel/pull/29492
`SedaComponent.defaultOfferTimeout` is a `long` holding a timeout in
milliseconds, but it is documented as a boolean toggle, because it was given
`defaultBlockWhenFull`'s description:
| Option | Type | Description |
| --- | --- | --- |
| `defaultBlockWhenFull` | boolean | Whether a thread that sends messages to
a full SEDA queue will block until the queue's capacity is no longer exhausted.
By default, an exception will be thrown … **the calling thread will instead
block and wait until the message can be accepted.** |
| `defaultOfferTimeout` | **long** | Whether a thread that sends messages to
a full SEDA queue will block until the queue's capacity is no longer exhausted.
By default, an exception will be thrown … **where a configured timeout can be
added to the block case. Using the offer(timeout) method of the underlining
java queue** |
The two are identical up to the last sentence, where the splice shows: *"By
enabling this option, where a configured timeout can be added to the block
case"* is not a sentence, and nothing tells the reader that the value is a
timeout or what 0 means.
The endpoint-level option for the same setting is already worded correctly:
```java
// SedaEndpoint
@UriParam(label = "producer,advanced", javaType = "java.time.Duration",
description = "Offer timeout can be added to the block case when
queue is full. You can disable timeout by"
+ " using 0 or a negative value.")
private long offerTimeout;
```
so `defaultOfferTimeout` is reworded after it, the same way
`defaultBlockWhenFull` and `defaultDiscardWhenFull` reuse their endpoint
counterparts' wording:
> Sets the default offer timeout, which can be added to the block case when
the queue is full. You can disable timeout by using 0 or a negative value.
`camel-stub` takes its component options from `SedaComponent`, so its
metadata, catalog entry and component DSL builder are updated alongside seda's.
`camel-vm` does not expose this option and is untouched.
The component DSL javadoc is machine-wrapped, so I reproduced the generator
(`78 - indent`, per `EndpointDslMojo.formatJavadocOrCommentStringAsList`) and
verified it regenerates the current text byte-for-byte before applying the
change. `component-builder.vm` appends a full stop only when the description
does not end in one, so unlike the old text the new wording gets no extra
period.
Documentation only — no behaviour change.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
