Merge pull request #5913 from pau101/document-close-reason

Document maximum close reason length
square · Mar 30, 2020 · b7a41a9 · b7a41a9
2 parents 4c1f65d + 7e2922e
commit b7a41a9
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/okhttp/src/main/java/okhttp3/WebSocket.kt b/okhttp/src/main/java/okhttp3/WebSocket.kt
@@ -98,8 +98,8 @@ interface WebSocket {
    *
    * @param code Status code as defined by
    *     [Section 7.4 of RFC 6455](http://tools.ietf.org/html/rfc6455#section-7.4).
-   * @param reason Reason for shutting down or null.
-   * @throws IllegalArgumentException if code is invalid.
+   * @param reason Reason for shutting down, no longer than 123 bytes of UTF-8 encoded data (**not** characters) or null.
+   * @throws IllegalArgumentException if [code] is invalid or [reason] is too long.
    */
   fun close(code: Int, reason: String?): Boolean