All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • rx.internal.operators.OperatorOnBackpressureBuffer Maven / Gradle / Ivy

    There is a newer version: 1.3.8
    Show newest version
    /**
 * Copyright 2014 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.internal.operators;

import static rx.BackpressureOverflow.ON_OVERFLOW_DEFAULT;

import java.util.concurrent.ConcurrentLinkedQueue;
import java.util.concurrent.atomic.*;

import rx.*;
import rx.BackpressureOverflow.Strategy;
import rx.Observable.Operator;
import rx.exceptions.*;
import rx.functions.Action0;
import rx.internal.util.BackpressureDrainManager;

public class OperatorOnBackpressureBuffer implements Operator {

    private final Long capacity;
    private final Action0 onOverflow;
    private final Strategy overflowStrategy;

    static final class Holder {
        static final OperatorOnBackpressureBuffer INSTANCE = new OperatorOnBackpressureBuffer();
    }

    @SuppressWarnings("unchecked")
    public static  OperatorOnBackpressureBuffer instance() {
        return (OperatorOnBackpressureBuffer) Holder.INSTANCE;
    }

    OperatorOnBackpressureBuffer() {
        this.capacity = null;
        this.onOverflow = null;
        this.overflowStrategy = ON_OVERFLOW_DEFAULT;
    }

    /**
     * Construct a new instance that will handle overflows with {@code ON_OVERFLOW_DEFAULT}, providing the
     * following behavior config:
     *
     * @param capacity the max number of items to be admitted in the buffer, must be greater than 0.
     */
    public OperatorOnBackpressureBuffer(long capacity) {
        this(capacity, null, ON_OVERFLOW_DEFAULT);
    }

    /**
     * Construct a new instance that will handle overflows with {@code ON_OVERFLOW_DEFAULT}, providing the
     * following behavior config:
     *
     * @param capacity the max number of items to be admitted in the buffer, must be greater than 0.
     * @param onOverflow the {@code Action0} to execute when the buffer overflows, may be null.
     */
    public OperatorOnBackpressureBuffer(long capacity, Action0 onOverflow) {
        this(capacity, onOverflow, ON_OVERFLOW_DEFAULT);
    }

    /**
     * Construct a new instance feeding the following behavior config:
     *
     * @param capacity the max number of items to be admitted in the buffer, must be greater than 0.
     * @param onOverflow the {@code Action0} to execute when the buffer overflows, may be null.
     * @param overflowStrategy the {@code BackpressureOverflow.Strategy} to handle overflows, it must not be null.
     */
    public OperatorOnBackpressureBuffer(long capacity, Action0 onOverflow,
                                        Strategy overflowStrategy) {
        if (capacity <= 0) {
            throw new IllegalArgumentException("Buffer capacity must be > 0");
        }
        if (overflowStrategy == null) {
            throw new NullPointerException("The BackpressureOverflow strategy must not be null");
        }
        this.capacity = capacity;
        this.onOverflow = onOverflow;
        this.overflowStrategy = overflowStrategy;
    }

    @Override
    public Subscriber call(final Subscriber child) {

        // don't pass through subscriber as we are async and doing queue draining
        // a parent being unsubscribed should not affect the children
        BufferSubscriber parent = new BufferSubscriber(child, capacity, onOverflow,
                                                             overflowStrategy);

        // if child unsubscribes it should unsubscribe the parent, but not the other way around
        child.add(parent);
        child.setProducer(parent.manager());

        return parent;
    }

    static final class BufferSubscriber extends Subscriber implements BackpressureDrainManager.BackpressureQueueCallback {
        // TODO get a different queue implementation
        private final ConcurrentLinkedQueue queue = new ConcurrentLinkedQueue();
        private final AtomicLong capacity;
        private final Subscriber child;
        private final AtomicBoolean saturated = new AtomicBoolean(false);
        private final BackpressureDrainManager manager;
        private final NotificationLite on = NotificationLite.instance();
        private final Action0 onOverflow;
        private final Strategy overflowStrategy;
        
        public BufferSubscriber(final Subscriber child, Long capacity, Action0 onOverflow,
                                Strategy overflowStrategy) {
            this.child = child;
            this.capacity = capacity != null ? new AtomicLong(capacity) : null;
            this.onOverflow = onOverflow;
            this.manager = new BackpressureDrainManager(this);
            this.overflowStrategy = overflowStrategy;
        }

        @Override
        public void onStart() {
            request(Long.MAX_VALUE);
        }

        @Override
        public void onCompleted() {
            if (!saturated.get()) {
                manager.terminateAndDrain();
            }
        }

        @Override
        public void onError(Throwable e) {
            if (!saturated.get()) {
                manager.terminateAndDrain(e);
            }
        }

        @Override
        public void onNext(T t) {
            if (!assertCapacity()) {
                return;
            }
            queue.offer(on.next(t));
            manager.drain();
        }

        @Override
        public boolean accept(Object value) {
            return on.accept(child, value);
        }
        @Override
        public void complete(Throwable exception) {
            if (exception != null) {
                child.onError(exception);
            } else {
                child.onCompleted();
            }
        }
        @Override
        public Object peek() {
            return queue.peek();
        }
        @Override
        public Object poll() {
            Object value = queue.poll();
            if (capacity != null && value != null) {
                capacity.incrementAndGet();
            }
            return value;
        }

        private boolean assertCapacity() {
            if (capacity == null) {
                return true;
            }

            long currCapacity;
            do {
                currCapacity = capacity.get();
                if (currCapacity <= 0) {
                    boolean hasCapacity = false;
                    try {
                        // ok if we're allowed to drop, and there is indeed an item to discard
                        hasCapacity = overflowStrategy.mayAttemptDrop() && poll() != null;
                    } catch (MissingBackpressureException e) {
                        if (saturated.compareAndSet(false, true)) {
                            unsubscribe();
                            child.onError(e);
                        }
                    }
                    if (onOverflow != null) {
                        try {
                            onOverflow.call();
                        } catch (Throwable e) {
                            Exceptions.throwIfFatal(e);
                            manager.terminateAndDrain(e);
                            // this line not strictly necessary but nice for clarity
                            // and in case of future changes to code after this catch block
                            return false;
                        }
                    }
                    if (!hasCapacity) {
                        return false;
                    }
                }
                // ensure no other thread stole our slot, or retry
            } while (!capacity.compareAndSet(currCapacity, currCapacity - 1));
            return true;
        }
        protected Producer manager() {
            return manager;
        }
    }
}
    
    
    
    

    




    
    
    © 2015 - 2024 Weber Informatics LLC | Privacy Policy