com.firefly.codec.websocket.model.OutgoingFrames Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of firefly Show documentation

There is a newer version: 5.0.0-dev6

package com.firefly.codec.websocket.model;

import com.firefly.codec.websocket.frame.Frame;
import com.firefly.utils.concurrent.Callback;

/**
 * Interface for dealing with frames outgoing to (eventually) the network layer.
 */
public interface OutgoingFrames {
    /**
     * 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.
     *
     * @param frame    the frame to eventually write to the network layer.
     * @param callback the callback to notify when the frame is written.
     */
    void outgoingFrame(Frame frame, Callback callback);

}