1 //
2 // ========================================================================
3 // Copyright (c) 1995-2013 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.WriteCallback;
22
23 /**
24 * Interface for dealing with frames outgoing to the network (eventually)
25 */
26 public interface OutgoingFrames
27 {
28 /**
29 * A frame, and optional callback, intended for the network.
30 * <p>
31 * Note: the frame can undergo many transformations in the various layers and extensions present in the implementation.
32 * <p>
33 * If you are implementing a mutation, you are obliged to handle the incoming WriteCallback appropriately.
34 *
35 * @param frame
36 * the frame to eventually write to the network.
37 * @param callback
38 * the optional callback to use for success/failure of the network write operation. Can be null.
39 */
40 void outgoingFrame(Frame frame, WriteCallback callback);
41 }