View Javadoc

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.common.frames;
20  
21  import org.eclipse.jetty.util.StringUtil;
22  import org.eclipse.jetty.websocket.common.OpCode;
23  
24  public class CloseFrame extends ControlFrame
25  {
26      public CloseFrame()
27      {
28          super(OpCode.CLOSE);
29      }
30  
31      @Override
32      public Type getType()
33      {
34          return Type.CLOSE;
35      }
36  
37      /**
38       * Truncate arbitrary reason into something that will fit into the CloseFrame limits.
39       * 
40       * @param reason
41       *            the arbitrary reason to possibly truncate.
42       * @return the possibly truncated reason string.
43       */
44      public static String truncate(String reason)
45      {
46          return StringUtil.truncate(reason,(ControlFrame.MAX_CONTROL_PAYLOAD - 2));
47      }
48  }