1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 package org.apache.shardingsphere.db.protocol.mysql.packet.generic;
19
20 import com.google.common.base.Preconditions;
21 import lombok.Getter;
22 import lombok.RequiredArgsConstructor;
23 import org.apache.shardingsphere.db.protocol.mysql.packet.MySQLPacket;
24 import org.apache.shardingsphere.db.protocol.mysql.payload.MySQLPacketPayload;
25
26 /**
27 * EOF packet protocol for MySQL.
28 *
29 * @see <a href="https://dev.mysql.com/doc/dev/mysql-server/latest/page_protocol_basic_eof_packet.html">EOF Packet</a>
30 */
31 @RequiredArgsConstructor
32 @Getter
33 public final class MySQLEofPacket extends MySQLPacket {
34
35 /**
36 * Header of EOF packet.
37 */
38 public static final int HEADER = 0xfe;
39
40 private final int warnings;
41
42 private final int statusFlags;
43
44 public MySQLEofPacket(final int statusFlags) {
45 this(0, statusFlags);
46 }
47
48 public MySQLEofPacket(final MySQLPacketPayload payload) {
49 Preconditions.checkArgument(HEADER == payload.readInt1(), "Header of MySQL EOF packet must be `0xfe`.");
50 warnings = payload.readInt2();
51 statusFlags = payload.readInt2();
52 }
53
54 @Override
55 protected void write(final MySQLPacketPayload payload) {
56 payload.writeInt1(HEADER);
57 payload.writeInt2(warnings);
58 payload.writeInt2(statusFlags);
59 }
60 }