View Javadoc
1   /*
2    * Copyright 2012 The Netty Project
3    *
4    * The Netty Project licenses this file to you under the Apache License,
5    * version 2.0 (the "License"); you may not use this file except in compliance
6    * with the License. You may obtain a copy of the License at:
7    *
8    *   http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13   * License for the specific language governing permissions and limitations
14   * under the License.
15   */
16  package io.netty.handler.codec;
17  
18  import io.netty.buffer.ByteBuf;
19  import io.netty.buffer.Unpooled;
20  
21  /**
22   * A set of commonly used delimiters for {@link DelimiterBasedFrameDecoder}.
23   */
24  public final class Delimiters {
25  
26      /**
27       * Returns a {@code NUL (0x00)} delimiter, which could be used for
28       * Flash XML socket or any similar protocols.
29       */
30      public static ByteBuf[] nulDelimiter() {
31          return new ByteBuf[] {
32                  Unpooled.wrappedBuffer(new byte[] { 0 }) };
33      }
34  
35      /**
36       * Returns {@code CR ('\r')} and {@code LF ('\n')} delimiters, which could
37       * be used for text-based line protocols.
38       */
39      public static ByteBuf[] lineDelimiter() {
40          return new ByteBuf[] {
41                  Unpooled.wrappedBuffer(new byte[] { '\r', '\n' }),
42                  Unpooled.wrappedBuffer(new byte[] { '\n' }),
43          };
44      }
45  
46      private Delimiters() {
47          // Unused
48      }
49  }