1 //
2 // ========================================================================
3 // Copyright (c) 1995-2015 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;
20
21 import org.eclipse.jetty.websocket.api.extensions.OutgoingFrames;
22
23 /**
24 * The possible batch modes when invoking {@link OutgoingFrames#outgoingFrame(org.eclipse.jetty.websocket.api.extensions.Frame, WriteCallback, BatchMode)}.
25 */
26 public enum BatchMode
27 {
28 /**
29 * Implementers are free to decide whether to send or not frames
30 * to the network layer.
31 */
32 AUTO,
33
34 /**
35 * Implementers must batch frames.
36 */
37 ON,
38
39 /**
40 * Implementers must send frames to the network layer.
41 */
42 OFF;
43
44 public static BatchMode max(BatchMode one, BatchMode two)
45 {
46 // Return the BatchMode that has the higher priority, where AUTO < ON < OFF.
47 return one.ordinal() < two.ordinal() ? two : one;
48 }
49 }