View Javadoc

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.common.extensions.mux;
20  
21  import org.eclipse.jetty.websocket.api.WriteCallback;
22  import org.eclipse.jetty.websocket.api.extensions.Frame;
23  import org.eclipse.jetty.websocket.common.LogicalConnection;
24  import org.eclipse.jetty.websocket.common.extensions.AbstractExtension;
25  
26  /**
27   * Multiplexing Extension for WebSockets.
28   * <p>
29   * Supporting <a href="https://tools.ietf.org/html/draft-ietf-hybi-websocket-multiplexing-08">draft-ietf-hybi-websocket-multiplexing-08</a> Specification.
30   */
31  public abstract class AbstractMuxExtension extends AbstractExtension
32  {
33      private Muxer muxer;
34  
35      public AbstractMuxExtension()
36      {
37          super();
38      }
39  
40      public abstract void configureMuxer(Muxer muxer);
41  
42      @Override
43      public void incomingFrame(Frame frame)
44      {
45          this.muxer.incomingFrame(frame);
46      }
47  
48      @Override
49      public void outgoingFrame(Frame frame, WriteCallback callback)
50      {
51          /* do nothing here, allow Muxer to handle this aspect */
52      }
53  
54      @Override
55      public void setConnection(LogicalConnection connection)
56      {
57          super.setConnection(connection);
58          if (muxer != null)
59          {
60              throw new RuntimeException("Cannot reset muxer physical connection once established");
61          }
62          this.muxer = new Muxer(connection);
63          configureMuxer(this.muxer);
64      }
65  }