javax.websocket

Class CloseReason

Contents

  • public class CloseReason
extends Object
    A class encapsulating the reason why a web socket has been closed, or why it is being asked to close. Note the acceptable uses of codes and reason phrase are defined in more detail by RFC 6455.
    Author:
    dannycoward

    • Constructor Detail

      • CloseReason

        public CloseReason(CloseReason.CloseCode closeCode,
                   String reasonPhrase)
        Creates a reason for closing a web socket connection with the given code and reason phrase.
        Parameters:
        closeCode - the close code, may not be null
        reasonPhrase - the reason phrase, may be null.

    • Method Detail

      • getCloseCode

        public CloseReason.CloseCode getCloseCode()
        The Close code associated with this CloseReason.
        Returns:
        the close code.

      • getReasonPhrase

        public String getReasonPhrase()
        The reason phrase associated with this CloseReason.
        Returns:
        the reason phrase. If there is no reason phrase, this returns the empty string

      • toString

        public String toString()
        Converts the CloseReason to a debug-friendly string. The exact format is not defined by the specification and may change in future releases.
        Overrides:
        toString in class Object
        Returns:
        A String representation of this CloseReason

Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/websocket/CloseReason.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com, CloseReason (Java(TM) EE 7 Specification APIs)

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.