Interface OutgoingFrames

All Known Subinterfaces:
CoreSession, Extension
All Known Implementing Classes:
AbstractExtension, CoreSession.Empty, ExtensionStack, JakartaWebSocketAsyncRemote, JakartaWebSocketAsyncRemote, JakartaWebSocketBasicRemote, JakartaWebSocketBasicRemote, JakartaWebSocketRemoteEndpoint, JakartaWebSocketRemoteEndpoint, JavaxWebSocketAsyncRemote, JavaxWebSocketBasicRemote, JavaxWebSocketRemoteEndpoint, WebSocketCoreSession
public interface OutgoingFrames
Interface for dealing with frames outgoing to (eventually) the network layer.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    sendFrame(Frame frame, Callback callback, boolean batch)
    A frame, and optional callback, intended for the network layer.

  • Method Details

    • sendFrame

      void sendFrame(Frame frame, Callback callback, boolean batch)
      A frame, and optional callback, intended for the network layer.

      Note: the frame can undergo many transformations in the various layers and extensions present in the implementation.

      If you are implementing a mutation, you are obliged to handle the incoming Callback appropriately.

      Parameters:
      frame - the frame to eventually write to the network layer.
      callback - the callback to notify when the frame is written.
      batch - the batch mode requested by the sender.