com.mysql.cj.protocol.ResultStreamer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mysql-connector-j Show documentation

JDBC Type 4 driver for MySQL.

There is a newer version: 9.1.0

/*
 * Copyright (c) 2015, 2024, Oracle and/or its affiliates.
 *
 * 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 designed to work with certain software 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 either included with the program or referenced in the documentation.
 *
 * 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.protocol;

/**
 * A result streamer is a result object that is streaming results from the current connection. It allows to stream as long as nothing else needs to happen on
 * the connection. Once something else needs to happen the streamed is notified to "complete streaming" at which point he can throw an exception, discard rows,
 * buffer rows, etc. The connection is then free to execute the next command.
 */
public interface ResultStreamer {

    /**
     * Finish the result streaming. This happens if a new command is started or the warnings/etc are requested. This is safe to call multiple times and only has
     * an effect the first time.
     */
    void finishStreaming();

}