Skip to content

Commit 0b9d4f8

Browse files
actions-useractions-user
committed
Sync documentation of main branch
1 parent 77026dc commit 0b9d4f8

10 files changed

+208
-119
lines changed

‎_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.websockets.next.WebSocketsRuntimeConfig‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎_generated-doc/main/config/all-configuration-roots-generated-doc/io.quarkus.websockets.next.WebSocketsServerRuntimeConfig‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
[{"configDocKey":{"type":"string","key":"quarkus.websockets-next.server.supported-subprotocols","additionalKeys":[],"configDoc":"See link:https://datatracker.ietf.org/doc/html/rfc6455#page-12[The WebSocket Protocol]","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"supported-subprotocols","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":true,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.server","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_SERVER_SUPPORTED_SUBPROTOCOLS","enum":false}},{"configDocKey":{"type":"boolean","key":"quarkus.websockets-next.server.per-message-compression-supported","additionalKeys":[],"configDoc":"Compression Extensions for WebSocket are supported by default.\n\nSee also link:https://datatracker.ietf.org/doc/html/rfc7692[RFC 7692]","withinAMap":false,"defaultValue":"true","javaDocSiteLink":"","docMapKey":"per-message-compression-supported","configPhase":"RUN_TIME","acceptedValues":null,"optional":false,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.server","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_SERVER_PER_MESSAGE_COMPRESSION_SUPPORTED","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.websockets-next.server.compression-level","additionalKeys":[],"configDoc":"The compression level must be a value between 0 and 9. The default value is `HttpServerOptions++#++DEFAULT_WEBSOCKET_COMPRESSION_LEVEL`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"compression-level","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.server","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_SERVER_COMPRESSION_LEVEL","enum":false}},{"configDocKey":{"type":"java.lang.Integer","key":"quarkus.websockets-next.server.max-message-size","additionalKeys":[],"configDoc":"The maximum size of a message in bytes. The default values is `HttpServerOptions++#++DEFAULT_MAX_WEBSOCKET_MESSAGE_SIZE`.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"","docMapKey":"max-message-size","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.server","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_SERVER_MAX_MESSAGE_SIZE","enum":false}},{"configDocKey":{"type":"java.time.Duration","key":"quarkus.websockets-next.server.auto-ping-interval","additionalKeys":[],"configDoc":"The interval after which, when set, the server sends a ping message to a connected client automatically.\n\nPing messages are not sent automatically by default.","withinAMap":false,"defaultValue":"","javaDocSiteLink":"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html","docMapKey":"auto-ping-interval","configPhase":"RUN_TIME","acceptedValues":null,"optional":true,"list":false,"passThroughMap":false,"withinAConfigGroup":false,"topLevelGrouping":"quarkus.websockets-next.server","since":null,"environmentVariable":"QUARKUS_WEBSOCKETS_NEXT_SERVER_AUTO_PING_INTERVAL","enum":false}}]

‎_generated-doc/main/config/extensions-configuration-roots-list/quarkus-websockets-next.adoc/io.quarkus.websockets.next.WebSocketsRuntimeConfig‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎_generated-doc/main/config/extensions-configuration-roots-list/quarkus-websockets-next.adoc/io.quarkus.websockets.next.WebSocketsServerRuntimeConfig‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
io.quarkus.websockets.next.WebSocketsServerRuntimeConfig

‎_generated-doc/main/config/quarkus-all-build-items.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -744,6 +744,7 @@ a| https://github.com/quarkusio/quarkus/blob/main/extensions/arc/deployment/src/
744744
a| `String propertyName` :: +++<i>No Javadoc found</i>+++
745745
`Type propertyType` :: +++<i>No Javadoc found</i>+++
746746
`String defaultValue` :: +++<i>No Javadoc found</i>+++
747+
`ExecutionMode executionMode` :: +++<i>No Javadoc found</i>+++
747748
748749
a| https://github.com/quarkusio/quarkus/blob/main/extensions/arc/deployment/src/main/java/io/quarkus/arc/deployment/ContextRegistrationPhaseBuildItem.java[`io.quarkus.arc.deployment.ContextRegistrationPhaseBuildItem`, window="_blank"] :: +++Context registration phase can be used to register custom CDI contexts. <p> An extension that needs to produce other build items during the "context registration" phase should use this build item. The build step should produce a or at least inject a for this build item, otherwise it could be ignored or processed at the wrong time, e.g. after . <p> Typical workflow involves obtaining a via . Note that there is no need to invoke once you are done as it is performed automatically.+++
749750
a| `BeanProcessor beanProcessor` :: +++<i>No Javadoc found</i>+++

‎_generated-doc/main/config/quarkus-all-config.adoc‎

Lines changed: 32 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -70096,24 +70096,24 @@ h|[[quarkus-websockets-next_quarkus-websockets-next-websockets-next]]link:#quark
7009670096
h|Type
7009770097
h|Default
7009870098

70099-
a| [[quarkus-websockets-next_quarkus-websockets-next-supported-subprotocols]]`link:#quarkus-websockets-next_quarkus-websockets-next-supported-subprotocols[quarkus.websockets-next.supported-subprotocols]`
70099+
a| [[quarkus-websockets-next_quarkus-websockets-next-server-supported-subprotocols]]`link:#quarkus-websockets-next_quarkus-websockets-next-server-supported-subprotocols[quarkus.websockets-next.server.supported-subprotocols]`
7010070100

7010170101

7010270102
[.description]
7010370103
--
7010470104
See link:https://datatracker.ietf.org/doc/html/rfc6455#page-12[The WebSocket Protocol]
7010570105

7010670106
ifdef::add-copy-button-to-env-var[]
70107-
Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SUPPORTED_SUBPROTOCOLS+++[]
70107+
Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_SUPPORTED_SUBPROTOCOLS+++[]
7010870108
endif::add-copy-button-to-env-var[]
7010970109
ifndef::add-copy-button-to-env-var[]
70110-
Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SUPPORTED_SUBPROTOCOLS+++`
70110+
Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_SUPPORTED_SUBPROTOCOLS+++`
7011170111
endif::add-copy-button-to-env-var[]
7011270112
--|list of string
7011370113
|
7011470114

7011570115

70116-
a| [[quarkus-websockets-next_quarkus-websockets-next-per-message-compression-supported]]`link:#quarkus-websockets-next_quarkus-websockets-next-per-message-compression-supported[quarkus.websockets-next.per-message-compression-supported]`
70116+
a| [[quarkus-websockets-next_quarkus-websockets-next-server-per-message-compression-supported]]`link:#quarkus-websockets-next_quarkus-websockets-next-server-per-message-compression-supported[quarkus.websockets-next.server.per-message-compression-supported]`
7011770117

7011870118

7011970119
[.description]
@@ -70123,49 +70123,69 @@ Compression Extensions for WebSocket are supported by default.
7012370123
See also link:https://datatracker.ietf.org/doc/html/rfc7692[RFC 7692]
7012470124

7012570125
ifdef::add-copy-button-to-env-var[]
70126-
Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_PER_MESSAGE_COMPRESSION_SUPPORTED+++[]
70126+
Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_PER_MESSAGE_COMPRESSION_SUPPORTED+++[]
7012770127
endif::add-copy-button-to-env-var[]
7012870128
ifndef::add-copy-button-to-env-var[]
70129-
Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_PER_MESSAGE_COMPRESSION_SUPPORTED+++`
70129+
Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_PER_MESSAGE_COMPRESSION_SUPPORTED+++`
7013070130
endif::add-copy-button-to-env-var[]
7013170131
--|boolean
7013270132
|`true`
7013370133

7013470134

70135-
a| [[quarkus-websockets-next_quarkus-websockets-next-compression-level]]`link:#quarkus-websockets-next_quarkus-websockets-next-compression-level[quarkus.websockets-next.compression-level]`
70135+
a| [[quarkus-websockets-next_quarkus-websockets-next-server-compression-level]]`link:#quarkus-websockets-next_quarkus-websockets-next-server-compression-level[quarkus.websockets-next.server.compression-level]`
7013670136

7013770137

7013870138
[.description]
7013970139
--
7014070140
The compression level must be a value between 0 and 9. The default value is `HttpServerOptions++#++DEFAULT_WEBSOCKET_COMPRESSION_LEVEL`.
7014170141

7014270142
ifdef::add-copy-button-to-env-var[]
70143-
Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_COMPRESSION_LEVEL+++[]
70143+
Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_COMPRESSION_LEVEL+++[]
7014470144
endif::add-copy-button-to-env-var[]
7014570145
ifndef::add-copy-button-to-env-var[]
70146-
Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_COMPRESSION_LEVEL+++`
70146+
Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_COMPRESSION_LEVEL+++`
7014770147
endif::add-copy-button-to-env-var[]
7014870148
--|int
7014970149
|
7015070150

7015170151

70152-
a| [[quarkus-websockets-next_quarkus-websockets-next-max-message-size]]`link:#quarkus-websockets-next_quarkus-websockets-next-max-message-size[quarkus.websockets-next.max-message-size]`
70152+
a| [[quarkus-websockets-next_quarkus-websockets-next-server-max-message-size]]`link:#quarkus-websockets-next_quarkus-websockets-next-server-max-message-size[quarkus.websockets-next.server.max-message-size]`
7015370153

7015470154

7015570155
[.description]
7015670156
--
7015770157
The maximum size of a message in bytes. The default values is `HttpServerOptions++#++DEFAULT_MAX_WEBSOCKET_MESSAGE_SIZE`.
7015870158

7015970159
ifdef::add-copy-button-to-env-var[]
70160-
Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_MAX_MESSAGE_SIZE+++[]
70160+
Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_MAX_MESSAGE_SIZE+++[]
7016170161
endif::add-copy-button-to-env-var[]
7016270162
ifndef::add-copy-button-to-env-var[]
70163-
Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_MAX_MESSAGE_SIZE+++`
70163+
Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_MAX_MESSAGE_SIZE+++`
7016470164
endif::add-copy-button-to-env-var[]
7016570165
--|int
7016670166
|
7016770167

7016870168

70169+
a| [[quarkus-websockets-next_quarkus-websockets-next-server-auto-ping-interval]]`link:#quarkus-websockets-next_quarkus-websockets-next-server-auto-ping-interval[quarkus.websockets-next.server.auto-ping-interval]`
70170+
70171+
70172+
[.description]
70173+
--
70174+
The interval after which, when set, the server sends a ping message to a connected client automatically.
70175+
70176+
Ping messages are not sent automatically by default.
70177+
70178+
ifdef::add-copy-button-to-env-var[]
70179+
Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_AUTO_PING_INTERVAL+++[]
70180+
endif::add-copy-button-to-env-var[]
70181+
ifndef::add-copy-button-to-env-var[]
70182+
Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_AUTO_PING_INTERVAL+++`
70183+
endif::add-copy-button-to-env-var[]
70184+
--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration]
70185+
link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]]
70186+
|
70187+
70188+
7016970189
h|[[quarkus-grpc_quarkus-grpc-grpc]]link:#quarkus-grpc_quarkus-grpc-grpc[gRPC]
7017070190

7017170191
h|Type

‎_generated-doc/main/config/quarkus-websockets-next-server-websockets-next-web-sockets-server-runtime-config.adoc‎

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
2+
:summaryTableId: quarkus-websockets-next-server-websockets-next-web-sockets-server-runtime-config
3+
[.configuration-legend]
4+
icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime
5+
[.configuration-reference, cols="80,.^10,.^10"]
6+
|===
7+
8+
h|[[quarkus-websockets-next-server-websockets-next-web-sockets-server-runtime-config_configuration]]link:#quarkus-websockets-next-server-websockets-next-web-sockets-server-runtime-config_configuration[Configuration property]
9+
10+
h|Type
11+
h|Default
12+
13+
a| [[quarkus-websockets-next-server-websockets-next-web-sockets-server-runtime-config_quarkus-websockets-next-server-supported-subprotocols]]`link:#quarkus-websockets-next-server-websockets-next-web-sockets-server-runtime-config_quarkus-websockets-next-server-supported-subprotocols[quarkus.websockets-next.server.supported-subprotocols]`
14+
15+
16+
[.description]
17+
--
18+
See link:https://datatracker.ietf.org/doc/html/rfc6455#page-12[The WebSocket Protocol]
19+
20+
ifdef::add-copy-button-to-env-var[]
21+
Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_SUPPORTED_SUBPROTOCOLS+++[]
22+
endif::add-copy-button-to-env-var[]
23+
ifndef::add-copy-button-to-env-var[]
24+
Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_SUPPORTED_SUBPROTOCOLS+++`
25+
endif::add-copy-button-to-env-var[]
26+
--|list of string
27+
|
28+
29+
30+
a| [[quarkus-websockets-next-server-websockets-next-web-sockets-server-runtime-config_quarkus-websockets-next-server-per-message-compression-supported]]`link:#quarkus-websockets-next-server-websockets-next-web-sockets-server-runtime-config_quarkus-websockets-next-server-per-message-compression-supported[quarkus.websockets-next.server.per-message-compression-supported]`
31+
32+
33+
[.description]
34+
--
35+
Compression Extensions for WebSocket are supported by default.
36+
37+
See also link:https://datatracker.ietf.org/doc/html/rfc7692[RFC 7692]
38+
39+
ifdef::add-copy-button-to-env-var[]
40+
Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_PER_MESSAGE_COMPRESSION_SUPPORTED+++[]
41+
endif::add-copy-button-to-env-var[]
42+
ifndef::add-copy-button-to-env-var[]
43+
Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_PER_MESSAGE_COMPRESSION_SUPPORTED+++`
44+
endif::add-copy-button-to-env-var[]
45+
--|boolean
46+
|`true`
47+
48+
49+
a| [[quarkus-websockets-next-server-websockets-next-web-sockets-server-runtime-config_quarkus-websockets-next-server-compression-level]]`link:#quarkus-websockets-next-server-websockets-next-web-sockets-server-runtime-config_quarkus-websockets-next-server-compression-level[quarkus.websockets-next.server.compression-level]`
50+
51+
52+
[.description]
53+
--
54+
The compression level must be a value between 0 and 9. The default value is `HttpServerOptions++#++DEFAULT_WEBSOCKET_COMPRESSION_LEVEL`.
55+
56+
ifdef::add-copy-button-to-env-var[]
57+
Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_COMPRESSION_LEVEL+++[]
58+
endif::add-copy-button-to-env-var[]
59+
ifndef::add-copy-button-to-env-var[]
60+
Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_COMPRESSION_LEVEL+++`
61+
endif::add-copy-button-to-env-var[]
62+
--|int
63+
|
64+
65+
66+
a| [[quarkus-websockets-next-server-websockets-next-web-sockets-server-runtime-config_quarkus-websockets-next-server-max-message-size]]`link:#quarkus-websockets-next-server-websockets-next-web-sockets-server-runtime-config_quarkus-websockets-next-server-max-message-size[quarkus.websockets-next.server.max-message-size]`
67+
68+
69+
[.description]
70+
--
71+
The maximum size of a message in bytes. The default values is `HttpServerOptions++#++DEFAULT_MAX_WEBSOCKET_MESSAGE_SIZE`.
72+
73+
ifdef::add-copy-button-to-env-var[]
74+
Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_MAX_MESSAGE_SIZE+++[]
75+
endif::add-copy-button-to-env-var[]
76+
ifndef::add-copy-button-to-env-var[]
77+
Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_MAX_MESSAGE_SIZE+++`
78+
endif::add-copy-button-to-env-var[]
79+
--|int
80+
|
81+
82+
83+
a| [[quarkus-websockets-next-server-websockets-next-web-sockets-server-runtime-config_quarkus-websockets-next-server-auto-ping-interval]]`link:#quarkus-websockets-next-server-websockets-next-web-sockets-server-runtime-config_quarkus-websockets-next-server-auto-ping-interval[quarkus.websockets-next.server.auto-ping-interval]`
84+
85+
86+
[.description]
87+
--
88+
The interval after which, when set, the server sends a ping message to a connected client automatically.
89+
90+
Ping messages are not sent automatically by default.
91+
92+
ifdef::add-copy-button-to-env-var[]
93+
Environment variable: env_var_with_copy_button:+++QUARKUS_WEBSOCKETS_NEXT_SERVER_AUTO_PING_INTERVAL+++[]
94+
endif::add-copy-button-to-env-var[]
95+
ifndef::add-copy-button-to-env-var[]
96+
Environment variable: `+++QUARKUS_WEBSOCKETS_NEXT_SERVER_AUTO_PING_INTERVAL+++`
97+
endif::add-copy-button-to-env-var[]
98+
--|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration]
99+
link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]]
100+
|
101+
102+
|===
103+
ifndef::no-duration-note[]
104+
[NOTE]
105+
[id='duration-note-anchor-{summaryTableId}']
106+
.About the Duration format
107+
====
108+
To write duration values, use the standard `java.time.Duration` format.
109+
See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information.
110+
111+
You can also use a simplified format, starting with a number:
112+
113+
* If the value is only a number, it represents time in seconds.
114+
* If the value is a number followed by `ms`, it represents time in milliseconds.
115+
116+
In other cases, the simplified format is translated to the `java.time.Duration` format for parsing:
117+
118+
* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`.
119+
* If the value is a number followed by `d`, it is prefixed with `P`.
120+
====
121+
endif::no-duration-note[]

0 commit comments

Comments
 (0)