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