org.apache.asterix.common.feeds.api.IFeedRuntime Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of asterix-common Show documentation

There is a newer version: 0.9.9

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.asterix.common.feeds.api;

import org.apache.asterix.common.feeds.FeedRuntimeId;
import org.apache.asterix.common.feeds.FeedRuntimeInputHandler;
import org.apache.hyracks.api.comm.IFrameWriter;

public interface IFeedRuntime {

    public enum FeedRuntimeType {
        INTAKE,
        COLLECT,
        COMPUTE_COLLECT,
        COMPUTE,
        STORE,
        OTHER,
        ETS,
        JOIN
    }

    public enum Mode {
        PROCESS,
        SPILL,
        PROCESS_SPILL,
        DISCARD,
        POST_SPILL_DISCARD,
        PROCESS_BACKLOG,
        STALL,
        FAIL,
        END
    }

    /**
     * @return the unique runtime id associated with the feedRuntime
     */
    public FeedRuntimeId getRuntimeId();

    /**
     * @return the frame writer associated with the feed runtime.
     */
    public IFrameWriter getFeedFrameWriter();

    public FeedRuntimeInputHandler getInputHandler();

}