Interface OutgoingFrames

All Known Subinterfaces:
Extension, LogicalConnection
All Known Implementing Classes:
AbstractExtension, AbstractWebSocketConnection, CompressExtension, DeflateFrameExtension, ExtensionStack, FragmentExtension, FrameCaptureExtension, FramePipes.Out2In, IdentityExtension, JsrSession, PerMessageDeflateExtension, WebSocketClientConnection, WebSocketServerConnection, WebSocketSession, XWebkitDeflateFrameExtension
public interface OutgoingFrames
Interface for dealing with frames outgoing to (eventually) the network layer.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    outgoingFrame(Frame frame, WriteCallback callback, BatchMode batchMode)
    A frame, and optional callback, intended for the network layer.

  • Method Details

    • outgoingFrame

      void outgoingFrame(Frame frame, WriteCallback callback, BatchMode batchMode)
      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 WriteCallback appropriately.

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