001/*
002 * Copyright 2022-2026 Revetware LLC.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package com.soklet;
018
019import org.jspecify.annotations.NonNull;
020
021import javax.annotation.concurrent.ThreadSafe;
022import java.util.Optional;
023
024/**
025 * Cooperative cancelation signal for an in-flight MCP JSON-RPC request.
026 * <p>
027 * Soklet does not interrupt handler threads when a client sends
028 * {@code notifications/cancelled}. Long-running handlers can poll this token
029 * and stop work at a safe application-defined point.
030 *
031 * @author <a href="https://www.revetkn.com">Mark Allen</a>
032 */
033@ThreadSafe
034public interface McpCancelationToken {
035        /**
036         * Indicates whether the client has requested cancelation for the current MCP request.
037         *
038         * @return {@code true} if cancelation was requested
039         */
040        @NonNull
041        Boolean isCancelationRequested();
042
043        /**
044         * Provides the client-supplied cancelation reason.
045         *
046         * @return the cancelation reason, if supplied
047         */
048        @NonNull
049        Optional<String> getReason();
050}