com.hazelcast.monitor.LocalFlakeIdGeneratorStats Maven / Gradle / Ivy
/*
* Copyright (c) 2008-2018, 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.monitor;
/**
* Local flake id statistics interface to be used
* by {@link com.hazelcast.monitor.MemberState} implementations.
*/
public interface LocalFlakeIdGeneratorStats extends LocalInstanceStats {
/**
* The average batch size can be calculated by dividing {@link #getIdCount()} by
* {@link #getBatchCount()}.
*
* @return the total number of times the ID generator has been used to generate
* a new ID batch since its {@link #getCreationTime()}.
*/
long getBatchCount();
/**
* Note that the ID count returned is the number of generated IDs not the number
* of consumed IDs.
*
* @return the total number of IDs generated (the sum of IDs for all batches)
* since its {@link #getCreationTime()}.
*/
long getIdCount();
}