All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.hazelcast.ringbuffer.impl.RingbufferProxy Maven / Gradle / Ivy

There is a newer version: 5.0-BETA-1
Show newest version
/*
 * Copyright (c) 2008-2015, Hazelcast, Inc. All Rights Reserved.
 *
 * 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 com.hazelcast.ringbuffer.impl;

import com.hazelcast.config.RingbufferConfig;
import com.hazelcast.core.ICompletableFuture;
import com.hazelcast.core.IFunction;
import com.hazelcast.nio.serialization.Data;
import com.hazelcast.ringbuffer.OverflowPolicy;
import com.hazelcast.ringbuffer.ReadResultSet;
import com.hazelcast.ringbuffer.Ringbuffer;
import com.hazelcast.ringbuffer.impl.operations.AddAllOperation;
import com.hazelcast.ringbuffer.impl.operations.AddOperation;
import com.hazelcast.ringbuffer.impl.operations.GenericOperation;
import com.hazelcast.ringbuffer.impl.operations.ReadManyOperation;
import com.hazelcast.ringbuffer.impl.operations.ReadOneOperation;
import com.hazelcast.spi.AbstractDistributedObject;
import com.hazelcast.spi.InternalCompletableFuture;
import com.hazelcast.spi.NodeEngine;
import com.hazelcast.spi.Operation;
import com.hazelcast.spi.OperationService;

import java.util.Collection;

import static com.hazelcast.ringbuffer.OverflowPolicy.OVERWRITE;
import static com.hazelcast.ringbuffer.impl.RingbufferService.SERVICE_NAME;
import static com.hazelcast.ringbuffer.impl.operations.GenericOperation.OPERATION_HEAD;
import static com.hazelcast.ringbuffer.impl.operations.GenericOperation.OPERATION_REMAINING_CAPACITY;
import static com.hazelcast.ringbuffer.impl.operations.GenericOperation.OPERATION_SIZE;
import static com.hazelcast.ringbuffer.impl.operations.GenericOperation.OPERATION_TAIL;
import static com.hazelcast.util.ExceptionUtil.rethrowAllowInterrupted;
import static com.hazelcast.util.Preconditions.checkFalse;
import static com.hazelcast.util.Preconditions.checkNotNegative;
import static com.hazelcast.util.Preconditions.checkNotNull;
import static com.hazelcast.util.Preconditions.checkTrue;
import static java.lang.String.format;

/**
 * The serverside proxy to access a {@link Ringbuffer}.
 *
 * @param  the type of the elements in the ringbuffer.
 */
public class RingbufferProxy extends AbstractDistributedObject implements Ringbuffer {

    // to prevent overloading on readMany/addAll, there is a hard limit
    static final int MAX_BATCH_SIZE = 1000;

    private final String name;
    private final int partitionId;
    private final RingbufferConfig config;

    public RingbufferProxy(NodeEngine nodeEngine, RingbufferService service, String name, RingbufferConfig config) {
        super(nodeEngine, service);
        this.name = name;
        this.partitionId = nodeEngine.getPartitionService().getPartitionId(getNameAsPartitionAwareData());
        this.config = config;
    }

    @Override
    public String getName() {
        return name;
    }

    @Override
    public String getServiceName() {
        return SERVICE_NAME;
    }

    @Override
    public long capacity() {
        return config.getCapacity();
    }

    @Override
    public long size() {
        GenericOperation op = new GenericOperation(name, OPERATION_SIZE);
        InternalCompletableFuture f = invoke(op);
        return (Long) f.getSafely();
    }

    @Override
    public long tailSequence() {
        GenericOperation op = new GenericOperation(name, OPERATION_TAIL);
        InternalCompletableFuture f = invoke(op);
        return (Long) f.getSafely();
    }

    @Override
    public long headSequence() {
        GenericOperation op = new GenericOperation(name, OPERATION_HEAD);
        InternalCompletableFuture f = invoke(op);
        return (Long) f.getSafely();
    }

    @Override
    public long remainingCapacity() {
        // we don't need to make a remote call if ttl is not set since in this case the remaining
        // capacity will always be equal to the capacity.
        if (config.getTimeToLiveSeconds() == 0) {
            return config.getCapacity();
        }

        GenericOperation op = new GenericOperation(name, OPERATION_REMAINING_CAPACITY);
        InternalCompletableFuture f = invoke(op);
        return (Long) f.getSafely();
    }

    @Override
    public long add(E item) {
        checkNotNull(item, "item can't be null");

        AddOperation op = new AddOperation(name, toData(item), OVERWRITE);
        InternalCompletableFuture f = invoke(op);
        return f.getSafely();
    }

    private Data toData(E item) {
        return getNodeEngine().getSerializationService().toData(item);
    }

    @Override
    public ICompletableFuture addAsync(E item, OverflowPolicy overflowPolicy) {
        checkNotNull(item, "item can't be null");
        checkNotNull(overflowPolicy, "overflowPolicy can't be null");

        AddOperation op = new AddOperation(name, toData(item), overflowPolicy);
        return invoke(op);
    }

    @Override
    public E readOne(long sequence) throws InterruptedException {
        checkSequence(sequence);

        ReadOneOperation op = new ReadOneOperation(name, sequence);
        InternalCompletableFuture f = invoke(op);
        try {
            return f.get();
        } catch (Throwable t) {
            throw rethrowAllowInterrupted(t);
        }
    }

    @Override
    public ICompletableFuture addAllAsync(Collection collection, OverflowPolicy overflowPolicy) {
        checkNotNull(collection, "collection can't be null");
        checkNotNull(overflowPolicy, "overflowPolicy can't be null");
        checkFalse(collection.isEmpty(), "collection can't be empty");
        checkTrue(collection.size() <= MAX_BATCH_SIZE, "collection can't be larger than " + MAX_BATCH_SIZE);

        AddAllOperation op = new AddAllOperation(name, toDataArray(collection), overflowPolicy);
        OperationService operationService = getOperationService();
        return operationService.createInvocationBuilder(null, op, partitionId)
                .setCallTimeout(Long.MAX_VALUE)
                .invoke();
    }

    private Data[] toDataArray(Collection collection) {
        Data[] items = new Data[collection.size()];
        int k = 0;
        for (E item : collection) {
            checkNotNull(item, "collection can't contains null items");
            items[k] = toData(item);
            k++;
        }
        return items;
    }

    @Override
    public ICompletableFuture> readManyAsync(long startSequence, int minCount, int maxCount,
                                                              IFunction filter) {
        checkSequence(startSequence);
        checkNotNegative(minCount, "minCount can't be smaller than 0");
        checkTrue(maxCount >= minCount, "maxCount should be equal or larger than minCount");
        checkTrue(minCount <= config.getCapacity(), "the minCount should be smaller than or equal to the capacity");
        checkTrue(maxCount <= MAX_BATCH_SIZE, "maxCount can't be larger than " + MAX_BATCH_SIZE);

        ReadManyOperation op = new ReadManyOperation(name, startSequence, minCount, maxCount, filter);
        OperationService operationService = getOperationService();
        return operationService.createInvocationBuilder(null, op, partitionId)
                .setCallTimeout(Long.MAX_VALUE)
                .invoke();
    }

    private  InternalCompletableFuture invoke(Operation op) {
        OperationService operationService = getOperationService();
        return operationService.invokeOnPartition(null, op, partitionId);
    }

    private static void checkSequence(long sequence) {
        if (sequence < 0) {
            throw new IllegalArgumentException("sequence can't be smaller than 0, but was: " + sequence);
        }
    }

    @Override
    public String toString() {
        return format("Ringbuffer{name='%s'}", name);
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy