com.mysql.cj.api.mysqla.io.PacketReader Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of mysql-connector-java
Show all versions of mysql-connector-java
JDBC Type 4 driver for MySQL
/*
* Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
*
* This program is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License, version 2.0, as published by the
* Free Software Foundation.
*
* This program is also distributed with certain software (including but not
* limited to OpenSSL) that is licensed under separate terms, as designated in a
* particular file or component or in included license documentation. The
* authors of MySQL hereby grant you an additional permission to link the
* program and your derivative works with the separately licensed software that
* they have included with MySQL.
*
* Without limiting anything contained in the foregoing, this file, which is
* part of MySQL Connector/J, is also subject to the Universal FOSS Exception,
* version 1.0, a copy of which can be found at
* http://oss.oracle.com/licenses/universal-foss-exception.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU General Public License, version 2.0,
* for more details.
*
* You should have received a copy of the GNU General Public License along with
* this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
package com.mysql.cj.api.mysqla.io;
import java.io.IOException;
import java.util.Optional;
public interface PacketReader {
/**
* Read MySQL packet header from input stream.
*
* @return
* @throws IOException
*/
PacketHeader readHeader() throws IOException;
/**
* Read MySQL packet payload from input stream into to the given {@link PacketPayload} instance or into the new one if not present.
*
* @param reuse
* {@link PacketPayload} to reuse
* @param packetLength
* Expected length of packet
* @return
* @throws IOException
*/
PacketPayload readPayload(Optional reuse, int packetLength) throws IOException;
/**
* Get last packet sequence number, as it was stored by {@link #readHeader(byte[], boolean)}.
*
* @return
*/
byte getPacketSequence();
/**
* Set stored packet sequence number to 0.
*/
void resetPacketSequence();
/**
* Return a PacketReader instance free of decorators.
*
* @return
*/
PacketReader undecorateAll();
/**
* Return the previous PacketReader instance from the decorators chain or the current PacketReader
* if it is the first entry in a chain.
*
* @return
*/
PacketReader undecorate();
}