Git Product home page Git Product logo

ipofflinequeue's Introduction

IPOfflineQueue is a persistent, serial task queue for iOS. It's especially ideal for queuing actions that require an internet connection that may be slow or absent.

  • You enqueue tasks to it, and they run whenever they can in a background thread.
  • Tasks are always executed in the order in which they were added (FIFO).
  • Tasks are not executed in parallel, although you are free to run parallel operations in your task-execution handler.
  • Queued tasks persist between application launches.
  • The application will remain running in the background until the queue completes or until iOS kills it (after no more than 10 minutes).
  • You're welcome to operate multiple queue instances if you'd like to run different tasks.
  • GCD is used extensively to prevent blocking the main thread.

If this is useful to you, please consider integrating send-to-Instapaper support in your app if it makes sense to do so. Details: http://www.instapaper.com/api

Status: extremely alpha

Really. Not even I'm using this in any shipping apps yet. Use at your own risk.

Usage

  • Requires iOS 4.0 or greater.
  • You must link libsqlite3.dylib with your project.

See ViewController.m in the sample project for a more detailed example, but it goes like this:

IPOfflineQueue *queue = [[IPOfflineQueue alloc] initWithName:@"main" delegate:self];

...

[queue enqueueActionWithUserInfo:myTaskDictionary];

...

- (IPOfflineQueueResult)offlineQueue:(IPOfflineQueue *)queue executeActionWithUserInfo:(NSDictionary *)userInfo
{
    // (try to do something)
    
    if (/* internet connection failed */) {
        return IPOfflineQueueResultFailureShouldPauseQueue;
    } else {
        return IPOfflineQueueResultSuccess;
    }
}

That's all you need to know about, really. (I hope.)

License

Copyright (c) 2011, Marco Arment All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  • Neither the name of Marco Arment nor the names of any contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MARCO ARMENT BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

(You may know this as the New BSD License.)

ipofflinequeue's People

Contributors

gcamp avatar marcoarment avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.