core/api/src/main/java/org/onosproject/net/pi/model/PiPacketOperationModel.java

/*
 * Copyright 2017-present Open Networking Foundation
 *
 * 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 org.onosproject.net.pi.model;

import com.google.common.annotations.Beta;

import java.util.List;

/**
 * Model of a packet operation in a protocol-independent pipeline.
 */
@Beta
public interface PiPacketOperationModel {

    /**
     * Returns the type of this packet operation.
     *
     * @return packet operation type
     */
    PiPacketOperationType type();

    /**
     * Returns a list of control metadata models for this packet operation. The metadata models are returned in the same
     * order as they would appear on the control header that is prepended to the packet.
     *
     * @return list of packet operation metadata models
     */
    List<PiControlMetadataModel> metadatas();

}