apps/bgpmonitoring/api/src/main/java/org/onosproject/bgpmonitoring/BmpMessageReader.java

/*
 * Copyright 2021-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.bgpmonitoring;

import org.jboss.netty.buffer.ChannelBuffer;
import org.onlab.packet.bmp.Bmp;

/**
 * Abstraction of an entity providing BMP Message Reader.
 */
public interface BmpMessageReader<T> {

    /**
     * Reads the Objects in the BMP Message and Returns BMP Message.
     *
     * @param cb        Channel Buffer
     * @param bmpHeader BMP message header
     * @return BMP Message
     * @throws BmpParseException on while parsing BMP message.
     */
    T readFrom(ChannelBuffer cb, Bmp bmpHeader) throws BmpParseException;
}