View Javadoc
1   /*
2    * This file is part of Waarp Project (named also Waarp or GG).
3    *
4    *  Copyright (c) 2019, Waarp SAS, and individual contributors by the @author
5    *  tags. See the COPYRIGHT.txt in the distribution for a full listing of
6    * individual contributors.
7    *
8    *  All Waarp Project is free software: you can redistribute it and/or
9    * modify it under the terms of the GNU General Public License as published by
10   * the Free Software Foundation, either version 3 of the License, or (at your
11   * option) any later version.
12   *
13   * Waarp is distributed in the hope that it will be useful, but WITHOUT ANY
14   * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
15   * A PARTICULAR PURPOSE. See the GNU General Public License for more details.
16   *
17   *  You should have received a copy of the GNU General Public License along with
18   * Waarp . If not, see <http://www.gnu.org/licenses/>.
19   */
20  package org.waarp.openr66.protocol.localhandler.packet;
21  
22  import io.netty.buffer.ByteBuf;
23  import io.netty.buffer.ByteBufAllocator;
24  import io.netty.buffer.Unpooled;
25  import org.waarp.openr66.protocol.exception.OpenR66ProtocolPacketException;
26  import org.waarp.openr66.protocol.localhandler.LocalChannelReference;
27  
28  /**
29   * No Op class
30   * <p>
31   * header = empty middle = empty end = empty
32   */
33  public class NoOpPacket extends AbstractLocalPacket {
34  
35    /**
36     * @param headerLength
37     * @param middleLength
38     * @param endLength
39     * @param buf
40     *
41     * @return the new EndTransferPacket from buffer
42     *
43     * @throws OpenR66ProtocolPacketException
44     */
45    public static NoOpPacket createFromBuffer(final int headerLength,
46                                              final int middleLength,
47                                              final int endLength,
48                                              final ByteBuf buf) {
49      return new NoOpPacket();
50    }
51  
52    @Override
53    public final boolean hasGlobalBuffer() {
54      return true;
55    }
56  
57    @Override
58    public final synchronized void createAllBuffers(
59        final LocalChannelReference lcr, final int networkHeader) {
60      final int globalSize = networkHeader + LOCAL_HEADER_SIZE;
61      global = ByteBufAllocator.DEFAULT.ioBuffer(globalSize, globalSize);
62      end = Unpooled.EMPTY_BUFFER;
63      header = Unpooled.EMPTY_BUFFER;
64      middle = Unpooled.EMPTY_BUFFER;
65    }
66  
67    @Override
68    public final byte getType() {
69      return LocalPacketFactory.NOOPPACKET;
70    }
71  
72    @Override
73    public final String toString() {
74      return "NoOpPacket";
75    }
76  
77  }