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

Jump to bottom

Updated JettyClientProperties#TOTAL_TIMEOUT related documentation. #5145

Merged
merged 1 commit into from
Sep 4, 2022
Merged

Updated JettyClientProperties#TOTAL_TIMEOUT related documentation. #5145

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 6 additions & 3 deletions ...y-connector/src/main/java/org/glassfish/jersey/jetty/connector/JettyClientProperties.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,17 +86,20 @@ private JettyClientProperties() {
"jersey.config.jetty.client.syncListenerResponseMaxSize";

/**
* Total timeout interval, in milliseconds.
* Total timeout interval for request/response conversation, in milliseconds.
* Opposed to {@link org.glassfish.jersey.client.ClientProperties#READ_TIMEOUT}.
* <p>
* The value MUST be an instance convertible to {@link java.lang.Integer}. A
* The value MUST be an instance convertible to {@link java.lang.Integer}. The
* value of zero (0) is equivalent to an interval of infinity.
* </p>
* <p>
* The default value is infinity (0).
* The default value is zero (infinity).
* </p>
* <p>
* The name of the configuration property is <tt>{@value}</tt>.
* </p>
*
* @since 2.37
*/
public static final String TOTAL_TIMEOUT = "jersey.config.jetty.client.totalTimeout";

Expand Down
17 changes: 17 additions & 0 deletions docs/src/main/docbook/appendix-properties.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1790,6 +1790,23 @@
</para>
</entry>
</row>
<row>
<entry>&jersey.jetty.JettyClientProperties.TOTAL_TIMEOUT;</entry>
<entry><literal>jersey.config.jetty.client.totalTimeout</literal></entry>
<entry>
<para>
Total timeout interval for request/response conversation, in milliseconds.
Opposed to &jersey.client.ClientProperties.READ_TIMEOUT;.
</para>
<para>
The value MUST be an instance convertible to <literal>Integer</literal>.
The value of zero <literal>0</literal> is equivalent to an interval of infinity.
</para>
<para>
The default value is <literal>0</literal> (infinity).
</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
Expand Down
1 change: 1 addition & 0 deletions docs/src/main/docbook/jersey.ent
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -470,6 +470,7 @@
<!ENTITY jersey.jetty.JettyClientProperties.DISABLE_COOKIES "<link xlink:href='&jersey.javadoc.uri.prefix;/jetty/connector/JettyClientProperties.html#DISABLE_COOKIES'>JettyClientProperties.DISABLE_COOKIES</link>" >
<!ENTITY jersey.jetty.JettyClientProperties.PREEMPTIVE_BASIC_AUTHENTICATION "<link xlink:href='&jersey.javadoc.uri.prefix;/jetty/connector/JettyClientProperties.html#PREEMPTIVE_BASIC_AUTHENTICATION'>JettyClientProperties.PREEMPTIVE_BASIC_AUTHENTICATION</link>" >
<!ENTITY jersey.jetty.JettyClientProperties.SYNC_LISTENER_RESPONSE_MAX_SIZE "<link xlink:href='&jersey.javadoc.uri.prefix;/jetty/connector/JettyClientProperties.html#SYNC_LISTENER_RESPONSE_MAX_SIZE'>JettyClientProperties.SYNC_LISTENER_RESPONSE_MAX_SIZE</link>" >
<!ENTITY jersey.jetty.JettyClientProperties.TOTAL_TIMEOUT "<link xlink:href='&jersey.javadoc.uri.prefix;/jetty/connector/JettyClientProperties.html#TOTAL_TIMEOUT'>JettyClientProperties.TOTAL_TIMEOUT</link>" >
<!ENTITY jersey.jetty.JettyConnectorProvider "<link xlink:href='&jersey.javadoc.uri.prefix;/jetty/connector/JettyConnectorProvider.html'>JettyConnectorProvider</link>">
<!ENTITY jersey.jetty.JettyHttpContainer "<link xlink:href='&jersey.javadoc.uri.prefix;/jetty/JettyHttpContainer.html'>JettyHttpContainer</link>">
<!ENTITY jersey.jetty.JettyHttpContainerFactory "<link xlink:href='&jersey.javadoc.uri.prefix;/jetty/JettyHttpContainerFactory.html'>JettyHttpContainerFactory</link>">
Expand Down