/*
    * Licensed to the Apache Software Foundation (ASF) under one or more
    * contributor license agreements.  See the NOTICE file distributed with
    * this work for additional information regarding copyright ownership.
    * The ASF licenses this file to You under the Apache License, Version 2.0
    * (the "License"); you may not use this file except in compliance with
    * the License.  You may obtain a copy of the License at
    *
    *     http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  
  package org.apache.shardingsphere.db.protocol.mysql.packet.generic;
  
  import com.google.common.base.Preconditions;
  import lombok.Getter;
  import lombok.RequiredArgsConstructor;
  import org.apache.shardingsphere.db.protocol.mysql.packet.MySQLPacket;
  import org.apache.shardingsphere.db.protocol.mysql.payload.MySQLPacketPayload;
  
  /**
   * OK packet protocol for MySQL.
   * 
   * @see <a href="https://dev.mysql.com/doc/dev/mysql-server/latest/page_protocol_basic_ok_packet.html">OK Packet</a>
   */
  @RequiredArgsConstructor
  @Getter
  public final class MySQLOKPacket extends MySQLPacket {
      
      /**
       * Header of OK packet.
       */
      public static final int HEADER = 0x00;
      
      private final long affectedRows;
      
      private final long lastInsertId;
      
      private final int statusFlag;
      
      private final int warnings;
      
      private final String info;
      
      public MySQLOKPacket(final int statusFlag) {
          this(0L, 0L, statusFlag, 0, "");
      }
      
      public MySQLOKPacket(final long affectedRows, final long lastInsertId, final int statusFlag) {
          this(affectedRows, lastInsertId, statusFlag, 0, "");
      }
      
      public MySQLOKPacket(final MySQLPacketPayload payload) {
          Preconditions.checkArgument(HEADER == payload.readInt1(), "Header of MySQL OK packet must be `0x00`.");
          affectedRows = payload.readIntLenenc();
          lastInsertId = payload.readIntLenenc();
          statusFlag = payload.readInt2();
          warnings = payload.readInt2();
          info = payload.readStringEOF();
      }
      
      @Override
      protected void write(final MySQLPacketPayload payload) {
          payload.writeInt1(HEADER);
          payload.writeIntLenenc(affectedRows);
          payload.writeIntLenenc(lastInsertId);
          payload.writeInt2(statusFlag);
          payload.writeInt2(warnings);
          payload.writeStringEOF(info);
      }
  }