Need help with RxDownload?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

ssseasonnn
4.0K Stars 608 Forks Apache License 2.0 593 Commits 30 Opened issues

Description

A multi-threaded download tool written with RxJava and Kotlin

Services available

!
?

Need anything else?

Contributors list

# 17,018
Kotlin
Java
rxjava
453 commits
# 143,836
Java
rxjava
Kotlin
10 commits
# 150,381
Java
rxjava
Kotlin
9 commits
# 97,165
Kotlin
iOS
Qt
rxkotli...
2 commits
# 157,403
Java
rxjava
Kotlin
Shell
1 commit
# 101,907
Kotlin
Dart
Flutter
SQLite
1 commit

RxDownload

A multi-threaded download tool written with RxJava and Kotlin

Read this in other languages: 中文English, Changelog 

Prepare

  • Add jitpack repo:

    maven { url 'https://jitpack.io' }
    
  • Add RxDownload dependency:

    //Load on demand
    implementation "com.github.ssseasonnn.RxDownload:rxdownload4:1.0.9"
    implementation "com.github.ssseasonnn.RxDownload:rxdownload4-manager:1.0.9"
    implementation "com.github.ssseasonnn.RxDownload:rxdownload4-notification:1.0.9"
    implementation "com.github.ssseasonnn.RxDownload:rxdownload4-recorder:1.0.9"
    
    

    or: //Add all dependencies of RxDownload4 implementation "com.github.ssseasonnn:RxDownload:1.0.9"

Basic Usage

  • Start download:

    disposable = url.download()
            .observeOn(AndroidSchedulers.mainThread())
            .subscribeBy(
                    onNext = { progress ->
                        //download progress
                        button.text = "${progress.downloadSizeStr()}/${progress.totalSizeStr()}"
                        button.setProgress(progress)
                    },
                    onComplete = {
                        //download complete
                        button.text = "Open"
                    },
                    onError = {
                        //download failed
                        button.text = "Retry"
                    }
            )    
    
  • Stop download:

    disposable.dispose()    
    
  • Get download file:

    val file = url.file()
    // or
    val file = task.file() 
    // use file...   
    
  • Delete download files:

    url.delete()
    // or
    task.delete() 
    

Task Manager

  • Get a TaskManager object:

    val taskManager = url.manager()
    
  • Subscribe to status update:

    //keep this tag for dispose
    val tag = taskManager.subscribe { status ->
        // Receive download status
        when (status) {
            is Normal -> {}
            is Started -> {}
            is Downloading -> {}
            is Paused -> {}
            is Completed -> {}
            is Failed -> {}
            is Deleted -> {}
        }
    }
    
    

    progress can be obtained from status, when status is Failed, you can get throwable from it, which is the reason for the failure.

  • Cancel status update subscription:

    //dispose tag
    taskManager.dispose(tag)
    
  • Start download:

    taskManager.start()
    
  • Stop download:

    taskManager.stop()
    
  • Delete download:

    taskManager.delete()
    
  • Get download file:

    val file = taskManager.file() 
    // use file...   
    

Task Recorder

  • Query single task:

     // Query task with url
     RxDownloadRecorder.getTask("url")
           .observeOn(AndroidSchedulers.mainThread())
           .subscribeBy { TaskEntity ->
               // TaskEntity                        
           } 
    
  • Query a batch of tasks:

     // Query task with urls
     RxDownloadRecorder.getTaskList("url1","url2","url3")
           .observeOn(AndroidSchedulers.mainThread())
           .subscribeBy { list ->
               // list of TaskEntity                        
           } 
    
  • Get a list of all downloads:

     RxDownloadRecorder.getAllTask()
           .observeOn(AndroidSchedulers.mainThread())
           .subscribeBy { list ->
               //list of TaskEntity                        
           }
    
  • Query all download records for a state:

     // Query all Completed records
     RxDownloadRecorder.getAllTaskWithStatus(Completed())
           .observeOn(AndroidSchedulers.mainThread())
           .subscribeBy { list ->
               //list of TaskEntity                        
           } 
    
  • Paging query download record list:

     RxDownloadRecorder.getTaskList(page, pageSize)
           .observeOn(AndroidSchedulers.mainThread())
           .subscribeBy { list ->
               //list of TaskEntity                        
           }
    
  • Paging query list of download records in a certain state:

     // Get the list of pages that have been Completed
     RxDownloadRecorder.getTaskListWithStatus(Completed(), page, pageSize)
           .observeOn(AndroidSchedulers.mainThread())
           .subscribeBy { list ->
               //list of TaskEntity                        
           }
    

    TaskEntity has a abnormalExit field, which is used to indicate whether the Task has paused by the APP forced close.

  • Start All:

     RxDownloadRecorder.startAll()
    
  • Stop All:

     RxDownloadRecorder.stopAll()
    
  • Delete All:

     RxDownloadRecorder.deleteAll()
    

License

Copyright 2019 Season.Zlc

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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.