equal
deleted
inserted
replaced
32 import java.util.concurrent.CompletableFuture; |
32 import java.util.concurrent.CompletableFuture; |
33 import java.util.concurrent.CompletionStage; |
33 import java.util.concurrent.CompletionStage; |
34 |
34 |
35 /** |
35 /** |
36 * A WebSocket client. |
36 * A WebSocket client. |
37 * {@Incubating} |
|
38 * |
37 * |
39 * <p> To create a {@code WebSocket} use the {@link HttpClient#newWebSocketBuilder} |
38 * <p> To create a {@code WebSocket} use the {@link HttpClient#newWebSocketBuilder} |
40 * method. To close a {@code WebSocket} use one of the {@code sendClose} or |
39 * method. To close a {@code WebSocket} use one of the {@code sendClose} or |
41 * {@code abort} methods. |
40 * {@code abort} methods. |
42 * |
41 * |
96 */ |
95 */ |
97 int NORMAL_CLOSURE = 1000; |
96 int NORMAL_CLOSURE = 1000; |
98 |
97 |
99 /** |
98 /** |
100 * A builder for creating {@code WebSocket} instances. |
99 * A builder for creating {@code WebSocket} instances. |
101 * {@Incubating} |
|
102 * |
100 * |
103 * <p> To obtain a {@code WebSocket} configure a builder as required by |
101 * <p> To obtain a {@code WebSocket} configure a builder as required by |
104 * calling intermediate methods (the ones that return the builder itself), |
102 * calling intermediate methods (the ones that return the builder itself), |
105 * then call {@code buildAsync()}. If an intermediate method is not called, |
103 * then call {@code buildAsync()}. If an intermediate method is not called, |
106 * an appropriate default value (or behavior) will be assumed. |
104 * an appropriate default value (or behavior) will be assumed. |
207 CompletableFuture<WebSocket> buildAsync(URI uri, Listener listener); |
205 CompletableFuture<WebSocket> buildAsync(URI uri, Listener listener); |
208 } |
206 } |
209 |
207 |
210 /** |
208 /** |
211 * The receiving interface of {@code WebSocket}. |
209 * The receiving interface of {@code WebSocket}. |
212 * {@Incubating} |
|
213 * |
210 * |
214 * <p> A {@code WebSocket} invokes methods on its listener when it receives |
211 * <p> A {@code WebSocket} invokes methods on its listener when it receives |
215 * messages or encounters events. The invoking {@code WebSocket} is passed |
212 * messages or encounters events. The invoking {@code WebSocket} is passed |
216 * as an argument to {@code Listener}'s methods. A {@code WebSocket} invokes |
213 * as an argument to {@code Listener}'s methods. A {@code WebSocket} invokes |
217 * methods on its listener in a thread-safe manner. |
214 * methods on its listener in a thread-safe manner. |
463 } |
460 } |
464 |
461 |
465 /** |
462 /** |
466 * A marker used by {@link WebSocket.Listener} for identifying partial |
463 * A marker used by {@link WebSocket.Listener} for identifying partial |
467 * messages. |
464 * messages. |
468 * {@Incubating} |
|
469 * |
465 * |
470 * @since 11 |
466 * @since 11 |
471 */ |
467 */ |
472 enum MessagePart { |
468 enum MessagePart { |
473 |
469 |