protocols/p4runtime/api/src/main/java/org/onosproject/p4runtime/api/P4RuntimePacketIn.java

/*
 * Copyright 2017-present Open Networking Laboratory
 *
 * 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.p4runtime.api;

import com.google.common.annotations.Beta;
import org.onlab.util.ImmutableByteSequence;
import org.onosproject.net.DeviceId;

import java.util.List;

/**
 * Information about a packet-in received from a P4Runtime device.
 */
@Beta
public interface P4RuntimePacketIn extends P4RuntimeEventSubject {

    /**
     * Returns the identifier of the device that generated this packet-in.
     *
     * @return device identifier
     */
    DeviceId deviceId();

    /**
     * Returns the packet raw data.
     *
     * @return byte sequence
     */
    ImmutableByteSequence data();

    /**
     * Returns the list of metadata associated with this packet-in, to be parsed by a
     * {@link org.onosproject.net.pi.model.PiPipelineInterpreter}.
     *
     * @return list of byte sequences
     */
    List<ImmutableByteSequence> metadata();
}