text: /*
   * Copyright (c) 2015 Spotify AB.
   *
   * 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.
   */
  #import <Foundation/Foundation.h>
  
  @protocol SPTCancellationToken;
  
  /**
   * The protocol an object listening to the cancellation token must conform to
   */
  @protocol SPTCancellationTokenDelegate <NSObject>
  
  /**
   * Called when the cancellation token becomes cancelled
   * @param cancellationToken The cancellation token that became cancelled
   */
  - (void)cancellationTokenDidCancel:(id<SPTCancellationToken>)cancellationToken;
  
  @end
  
  /**
   * A cancellation token used for cancelling specific requests
   */
  @protocol SPTCancellationToken <NSObject>
  
  /**
   * Whether the cancellation token has been cancelled
   */
  @property (nonatomic, assign, readonly, getter = isCancelled) BOOL cancelled;
  /**
   * The object listening to the cancellation token
   * @discussion This is immutable, the cancellation token should be fed this on its creation
   */
  @property (nonatomic, weak, readonly) id<SPTCancellationTokenDelegate> delegate;
  /**
   * The object that will be affected by the cancellation
   */
  @property (nonatomic, strong, readonly) id objectToCancel;
  
  /**
   * Cancels the cancellation token
   */
  - (void)cancel;
  
  @end
  