rx.lang.scala.schedulers.ThreadPoolForIOScheduler.scala Maven / Gradle / Ivy

Go to download
/**
 * Copyright 2013 Netflix, Inc.
 *
 * 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.
 */
package rx.lang.scala.schedulers

import rx.lang.scala.Scheduler

object ThreadPoolForIOScheduler {

  /**
   * [[rx.lang.scala.Scheduler]] intended for IO-bound work.
   *
   * The implementation is backed by an `java.util.concurrent.Executor` thread-pool that will grow as needed.
   *
   * This can be used for asynchronously performing blocking IO.
   *
   * Do not perform computational work on this scheduler. Use [[rx.lang.scala.schedulers.ThreadPoolForComputationScheduler]] instead.
   */
  def apply(): ThreadPoolForIOScheduler = {
    new ThreadPoolForIOScheduler(rx.schedulers.Schedulers.threadPoolForIO())
  }
}

class ThreadPoolForIOScheduler private[scala] (val asJavaScheduler: rx.Scheduler)
  extends Scheduler {}