com.mysql.cj.protocol.MessageListener Maven / Gradle / Ivy
/*
* Copyright (c) 2016, 2020, 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 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.protocol;
import com.mysql.cj.exceptions.CJOperationNotSupportedException;
import com.mysql.cj.exceptions.ExceptionFactory;
/**
* Sink for messages that are read asynchonously from the socket.
*
* Return whether the listener is done receiving messages.
*
* @param
* Message type
*/
public interface MessageListener {
/**
* Process protocol message.
*
* @param message
* {@link Message} instance
* @return true - if this listener is done with processing the messages sequence and may be discarded;
* false - if the next message must be dispatched to the same listener
*/
default boolean processMessage(M message) {
throw ExceptionFactory.createException(CJOperationNotSupportedException.class, "Not allowed");
}
/**
* Exceptionally complete underlying Future.
*
* @param ex
* exception to pass to underlying Future.
*/
void error(Throwable ex);
}