Package org.apache.tomcat.websocket

Class WsIOException

  • All Implemented Interfaces:
    java.io.Serializable
    public class WsIOException
extends java.io.IOException
    Allows the WebSocket implementation to throw an IOException that includes a CloseReason specific to the error that can be passed back to the client.
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      WsIOException​(CloseReason closeReason)
      Creates a WebSocket I/O exception with the given close reason.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      CloseReason getCloseReason()
      Returns the WebSocket close reason for this exception.

      • Methods inherited from class java.lang.Throwable

        addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • WsIOException

        public WsIOException​(CloseReason closeReason)
        Creates a WebSocket I/O exception with the given close reason.
        Parameters:
        closeReason - the WebSocket close reason

    • Method Detail

      • getCloseReason

        public CloseReason getCloseReason()
        Returns the WebSocket close reason for this exception.
        Returns:
        the close reason