/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [http://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * 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 for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.neo4j.bolt.protocol.common.message.request;

/**
 * Encapsulates virtual requests which originate from within the Bolt server implementation and cannot be transmitted via the wire.
 */
public enum Signal implements RequestMessage {

    /**
     * Interrupts a given operation within a given state machine.
     * <p>
     * <b>Important:</b> This signal may be triggered through a side channel (e.g. outside the normal thread model).
     */
    INTERRUPT;

    @Override
    public boolean safeToProcessInAnyState() {
        return false;
    }
}
