net.openhft.chronicle.wire.channel.ReplyingHandler Maven / Gradle / Ivy
/*
* Copyright 2016-2022 chronicle.software
*
* https://chronicle.software
*
* 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 net.openhft.chronicle.wire.channel;
import net.openhft.chronicle.core.io.ClosedIORuntimeException;
/**
* An abstract handler that provides a mechanism for sending responses in a communication protocol.
* Typically, these responses could be of type OkHeader, ReplyHeader, ErrorHandler.
*
* It extends {@link AbstractHandler}, and subclasses of this handler are expected to implement
* the {@link #responseHeader(ChronicleContext)} method to provide a custom channel header for responses.
*
* @param The specific subclass of ReplyingHandler, used for ensuring type correctness in fluent APIs.
*/
@SuppressWarnings("deprecation")
public abstract class ReplyingHandler> extends AbstractHandler {
@Override
public abstract ChannelHeader responseHeader(ChronicleContext context);
@Override
public void run(ChronicleContext context, ChronicleChannel channel) throws ClosedIORuntimeException {
// This method is intentionally left blank
}
@Override
public ChronicleChannel asInternalChannel(ChronicleContext context, ChronicleChannelCfg channelCfg) {
throw new UnsupportedOperationException("asInternalChannel operation is not supported in ReplyingHandler");
}
}