/*
 * Copyright (c) 2016 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.bgp.evpn.spi;

import io.netty.buffer.ByteBuf;
import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev200120.NlriType;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev200120.evpn.EvpnChoice;
import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;

@NonNullByDefault
public interface EvpnRegistry {
    /**
     * Decode input buffer to BGP Evpn.
     *
     * @param type Nlri Type
     * @param buffer encoded EvpnChoice body in Bytebuf
     * @return EvpnChoice
     */
    @Nullable EvpnChoice parseEvpn(NlriType type, ByteBuf buffer);

    /**
     * Encode input BGP Evpn to output buffer.
     *
     * @param evpn EvpnChoice
     * @param common encoded common Evpn
     * @return encoded EvpnChoice body in Bytebuf
     */
    ByteBuf serializeEvpn(EvpnChoice evpn, ByteBuf common);

    /**
     * Decode Evpn Model to Evpn.
     *
     * @param evpnChoice ChoiceNode containing Evpn
     * @return EvpnChoice
     */
    @Nullable EvpnChoice serializeEvpnModel(ChoiceNode evpnChoice);

    /**
     * Create Route key from Evpn model.
     *
     * @param evpnChoice ChoiceNode containing Evpn
     * @return EvpnChoice
     */
    @Nullable EvpnChoice serializeEvpnRouteKey(ChoiceNode evpnChoice);
}