csharp/src/Drivers/Databricks/Reader/IOperationStatusPoller.cs

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.
 */

using System;
using System.Threading;

namespace Apache.Arrow.Adbc.Drivers.Databricks.Reader
{
    /// <summary>
    /// Interface for operation status polling functionality.
    /// </summary>
    internal interface IOperationStatusPoller : IDisposable
    {
        /// <summary>
        /// Gets a value indicating whether the poller has been started.
        /// </summary>
        bool IsStarted { get; }

        /// <summary>
        /// Starts the operation status poller.
        /// </summary>
        /// <param name="externalToken">The external cancellation token.</param>
        void Start(CancellationToken externalToken = default);

        /// <summary>
        /// Stops the operation status poller.
        /// </summary>
        void Stop();
    }
}