Interface OutgoingFrames

All Known Subinterfaces:

CoreSession, Extension

All Known Implementing Classes:

AbstractExtension, CoreSession.Empty, ExtensionStack, FragmentingFlusher, JakartaWebSocketAsyncRemote, JakartaWebSocketAsyncRemote, JakartaWebSocketAsyncRemote, JakartaWebSocketBasicRemote, JakartaWebSocketBasicRemote, JakartaWebSocketBasicRemote, JakartaWebSocketRemoteEndpoint, JakartaWebSocketRemoteEndpoint, JakartaWebSocketRemoteEndpoint, JavaxWebSocketAsyncRemote, JavaxWebSocketBasicRemote, JavaxWebSocketRemoteEndpoint, WebSocketCoreSession, WebSocketFlusher

public interface OutgoingFrames

Interface for dealing with frames outgoing to (eventually) the network layer.

Method Summary

Modifier and Type	Method	Description
default void	sendFrame(Frame frame, Callback callback, boolean batch)	A frame, callback, intended for the network layer.
void	sendFrame(OutgoingEntry entry)	Send an OutgoingEntry containing a Frame and Callback.

Method Details

sendFrame

default void sendFrame(Frame frame,
 Callback callback,
 boolean batch)

A frame, 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.

sendFrame

void sendFrame(OutgoingEntry entry)

Send an OutgoingEntry containing a Frame and Callback.

Parameters:

entry - the frame to eventually write to the network layer.