monifu.reactive.channels.PublishChannel.scala Maven / Gradle / Ivy
/*
* Copyright (c) 2014-2015 by its authors. Some rights reserved.
* See the project homepage at: http://www.monifu.org
*
* 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 monifu.reactive.channels
import monifu.concurrent.Scheduler
import monifu.reactive.OverflowStrategy
import monifu.reactive.subjects.PublishSubject
/**
* Represents a [[monifu.reactive.Channel Channel]] that uses an underlying
* [[monifu.reactive.subjects.PublishSubject PublishSubject]].
*/
final class PublishChannel[T] private
(policy: OverflowStrategy.Synchronous, onOverflow: Long => T)
(implicit s: Scheduler)
extends SubjectChannel(PublishSubject[T](), policy, onOverflow)(s)
object PublishChannel {
/**
* Builds a [[monifu.reactive.Channel Channel]] that uses an underlying
* [[monifu.reactive.subjects.PublishSubject PublishSubject]].
*
* @param strategy - the [[OverflowStrategy overflow strategy]]
* used for buffering, which specifies what to do in case
* we're dealing with slow consumers: should an unbounded
* buffer be used, should back-pressure be applied, should
* the pipeline drop newer or older events, should it drop
* the whole buffer? See [[OverflowStrategy]] for more
* details.
*/
def apply[T](strategy: OverflowStrategy.Synchronous)
(implicit s: Scheduler): PublishChannel[T] = {
new PublishChannel[T](strategy, null)
}
/**
* Builds a [[monifu.reactive.Channel Channel]] that uses an underlying
* [[monifu.reactive.subjects.PublishSubject PublishSubject]].
*
* @param strategy - the [[OverflowStrategy overflow strategy]]
* used for buffering, which specifies what to do in case
* we're dealing with slow consumers: should an unbounded
* buffer be used, should back-pressure be applied, should
* the pipeline drop newer or older events, should it drop
* the whole buffer? See [[OverflowStrategy]] for more
* details.
*
* @param onOverflow - a function that is used for signaling a special
* event used to inform the consumers that an overflow event
* happened, function that receives the number of dropped
* events as a parameter (see [[OverflowStrategy.WithSignal]])
*/
def apply[T](strategy: OverflowStrategy.WithSignal, onOverflow: Long => T)
(implicit s: Scheduler): PublishChannel[T] = {
new PublishChannel[T](strategy, onOverflow)
}
}