org.opendaylight.protocol.rsvp.parser.spi.XROSubobjectRegistry Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rsvp-spi Show documentation

RSVP SPI

There is a newer version: 0.22.6

/*
 * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */

package org.opendaylight.protocol.rsvp.parser.spi;

import io.netty.buffer.ByteBuf;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.exclude.route.object.exclude.route.object.SubobjectContainer;

public interface XROSubobjectRegistry {
    /**
     * Finds parser for given subobject type in the registry. Delegates parsing to found parser.
     *
     * @param type      subobject type, key in parser registry
     * @param buffer    subobject wrapped in ByteBuf
     * @param mandatory XRO specific common field
     * @return null if the parser for this subobject could not be found
     * @throws RSVPParsingException if the parsing did not succeed
     */
    SubobjectContainer parseSubobject(int type, ByteBuf buffer, boolean mandatory) throws RSVPParsingException;

    /**
     * Find serializer for given subobject. Delegates parsing to found serializer.
     *
     * @param subobject to be parsed
     * @param buffer    buffer where the serialized subobject will be parsed
     */
    void serializeSubobject(SubobjectContainer subobject, ByteBuf buffer);
}