Module org.eclipse.jetty.websocket.jetty.common
Package org.eclipse.jetty.websocket.common

Class JettyWebSocketFrameHandler

    • Constructor Detail

      • JettyWebSocketFrameHandler

        public JettyWebSocketFrameHandler​(WebSocketContainer container,
                                  java.lang.Object endpointInstance,
                                  java.lang.invoke.MethodHandle openHandle,
                                  java.lang.invoke.MethodHandle closeHandle,
                                  java.lang.invoke.MethodHandle errorHandle,
                                  java.lang.invoke.MethodHandle textHandle,
                                  java.lang.invoke.MethodHandle binaryHandle,
                                  java.lang.Class<? extends MessageSink> textSinkClass,
                                  java.lang.Class<? extends MessageSink> binarySinkClass,
                                  java.lang.invoke.MethodHandle frameHandle,
                                  java.lang.invoke.MethodHandle pingHandle,
                                  java.lang.invoke.MethodHandle pongHandle,
                                  BatchMode batchMode,
                                  Configuration.Customizer customizer)

    • Method Detail

      • setUpgradeRequest

        public void setUpgradeRequest​(UpgradeRequest upgradeRequest)

      • setUpgradeResponse

        public void setUpgradeResponse​(UpgradeResponse upgradeResponse)

      • getBatchMode

        public BatchMode getBatchMode()

      • onOpen

        public void onOpen​(CoreSession coreSession,
                   Callback callback)
        Description copied from interface: FrameHandler
        Async notification that Connection is being opened.

        FrameHandler can write during this call, but can not receive frames until the callback is succeeded.

        If the FrameHandler succeeds the callback we transition to OPEN state and can now receive frames if not demanding, or can now call CoreSession.demand(long) to receive frames if demanding. If the FrameHandler fails the callback a close frame will be sent with CloseStatus.SERVER_ERROR and the connection will be closed.

        Specified by:
        onOpen in interface FrameHandler
        Parameters:
        coreSession - the session associated with this connection.
        callback - the callback to indicate success in processing (or failure)

      • onFrame

        public void onFrame​(Frame frame,
                    Callback callback)
        Description copied from interface: FrameHandler
        Receiver of all Frames. This method will never be called in parallel for the same session and will be called sequentially to satisfy all outstanding demand signaled by calls to CoreSession.demand(long). Control and Data frames are passed to this method. Close frames may be responded to by the handler, but if an appropriate close response is not sent once the callback is succeeded, then a response close will be generated and sent.
        Specified by:
        onFrame in interface FrameHandler
        Specified by:
        onFrame in interface IncomingFrames
        Parameters:
        frame - the raw frame
        callback - the callback to indicate success in processing frame (or failure)

      • onError

        public void onError​(java.lang.Throwable cause,
                    Callback callback)
        Description copied from interface: FrameHandler
        An error has occurred or been detected in websocket-core and being reported to FrameHandler. A call to onError will be followed by a call to FrameHandler.onClosed(CloseStatus, Callback) giving the close status derived from the error. This will not be called more than once, FrameHandler.onClosed(CloseStatus, Callback) will be called on the callback completion.
        Specified by:
        onError in interface FrameHandler
        Parameters:
        cause - the reason for the error
        callback - the callback to indicate success in processing (or failure)

      • onClosed

        public void onClosed​(CloseStatus closeStatus,
                     Callback callback)
        Description copied from interface: FrameHandler
        This is the Close Handshake Complete event.

        The connection is now closed, no reading or writing is possible anymore. Implementations of FrameHandler can cleanup their resources for this connection now. This method will be called only once.

        Specified by:
        onClosed in interface FrameHandler
        Parameters:
        closeStatus - the close status received from remote, or in the case of abnormal closure from local.
        callback - the callback to indicate success in processing (or failure)

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • isDemanding

        public boolean isDemanding()
        Description copied from interface: FrameHandler
        Does the FrameHandler manage it's own demand?
        Specified by:
        isDemanding in interface FrameHandler
        Returns:
        true iff the FrameHandler will manage its own flow control by calling CoreSession.demand(long) when it is willing to receive new Frames. Otherwise the demand will be managed by an automatic call to demand(1) after every succeeded callback passed to FrameHandler.onFrame(Frame, Callback).

      • suspend

        public void suspend()

      • resume

        public void resume()

      • convertCause

        public static java.lang.Throwable convertCause​(java.lang.Throwable cause)