io.atomix.copycat.protocol.CommandResponse Maven / Gradle / Ivy
/*
* Copyright 2015 the original author or authors.
*
* 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 io.atomix.copycat.protocol;
/**
* Client command response.
*
* Command responses are sent by servers to clients upon the completion of a
* {@link CommandRequest}. Command responses are sent with the
* {@link #index()} (or index) of the state machine at the point at which the command was evaluated.
* This can be used by the client to ensure it sees state progress monotonically. Note, however, that
* command responses may not be sent or received in sequential order. If a command response has to await
* the completion of an event, or if the response is proxied through another server, responses may be
* received out of order. Clients should resequence concurrent responses to ensure they're handled in FIFO order.
*
* @author Jordan Halterman
*/
public class CommandResponse extends OperationResponse {
/**
* Returns a new submit response builder.
*
* @return A new submit response builder.
*/
public static Builder builder() {
return new Builder(new CommandResponse());
}
/**
* Returns a submit response builder for an existing request.
*
* @param response The response to build.
* @return The submit response builder.
* @throws NullPointerException if {@code request} is null
*/
public static Builder builder(CommandResponse response) {
return new Builder(response);
}
/**
* Command response builder.
*/
public static class Builder extends OperationResponse.Builder {
protected Builder(CommandResponse response) {
super(response);
}
}
}