org.neo4j.driver.internal.messaging.request.ResetMessage Maven / Gradle / Ivy
Show all versions of neo4j-java-driver-all Show documentation
/*
* Copyright (c) "Neo4j"
* Neo4j Sweden AB [http://neo4j.com]
*
* This file is part of Neo4j.
*
* Licensed 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.neo4j.driver.internal.messaging.request;
import org.neo4j.driver.internal.messaging.Message;
/**
* RESET request message
*
* Sent by clients to reset a session to a clean state - closing any open transaction or result streams.
* This also acknowledges receipt of failures sent by the server. This is required to
* allow optimistic sending of multiple messages before responses have been received - pipelining.
*
* When something goes wrong, we want the server to stop processing our already sent messages,
* but the server cannot tell the difference between what was sent before and after we saw the
* error.
*
* This message acts as a barrier after an error, informing the server that we've seen the error
* message, and that messages that follow this one are safe to execute.
*/
public class ResetMessage implements Message {
public static final byte SIGNATURE = 0x0F;
public static final ResetMessage RESET = new ResetMessage();
private ResetMessage() {}
@Override
public byte signature() {
return SIGNATURE;
}
@Override
public String toString() {
return "RESET";
}
}