1 //
2 // ========================================================================
3 // Copyright (c) 1995-2016 Mort Bay Consulting Pty. Ltd.
4 // ------------------------------------------------------------------------
5 // All rights reserved. This program and the accompanying materials
6 // are made available under the terms of the Eclipse Public License v1.0
7 // and Apache License v2.0 which accompanies this distribution.
8 //
9 // The Eclipse Public License is available at
10 // http://www.eclipse.org/legal/epl-v10.html
11 //
12 // The Apache License v2.0 is available at
13 // http://www.opensource.org/licenses/apache2.0.php
14 //
15 // You may elect to redistribute this code under either of these licenses.
16 // ========================================================================
17 //
18
19 package org.eclipse.jetty.websocket.api.extensions;
20
21 import org.eclipse.jetty.websocket.api.BatchMode;
22 import org.eclipse.jetty.websocket.api.WriteCallback;
23
24 /**
25 * Interface for dealing with frames outgoing to (eventually) the network layer.
26 */
27 public interface OutgoingFrames
28 {
29 /**
30 * A frame, and optional callback, intended for the network layer.
31 * <p>
32 * Note: the frame can undergo many transformations in the various
33 * layers and extensions present in the implementation.
34 * <p>
35 * If you are implementing a mutation, you are obliged to handle
36 * the incoming WriteCallback appropriately.
37 *
38 * @param frame the frame to eventually write to the network layer.
39 * @param callback the callback to notify when the frame is written.
40 * @param batchMode the batch mode requested by the sender.
41 */
42 void outgoingFrame(Frame frame, WriteCallback callback, BatchMode batchMode);
43
44 }