src/com/android/tradefed/cluster/IClusterEventUploader.java

/*
 * Copyright (C) 2019 The Android Open Source Project
 *
 * 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.android.tradefed.cluster;

/** Interface for ClusterEventUploader */
public interface IClusterEventUploader<T extends IClusterEvent> {
    /**
     * Get the maximum number of events to upload at once.
     *
     * @param batchSize the maximum number of events to upload at once.
     */
    public void setMaxBatchSize(int batchSize);

    /**
     * Get the maximum batch size used when uploading events.
     *
     * @return the maximum batch size.
     */
    public int getMaxBatchSize();

    /**
     * Set how often we upload events to TFC.
     *
     * @param interval in ms for events to be uploaded to TFC.
     */
    public void setEventUploadInterval(long interval);

    /**
     * Get the upload interval.
     *
     * @return the upload interval in ms.
     */
    public long getEventUploadInterval();

    /**
     * Posts an event to TFC. This queues the event to be uploaded. Events will be batched and
     * uploaded.
     *
     * @param event the event to upload
     */
    void postEvent(final T event);

    /** Force an upload of all events queued. */
    void flush();
}