/*
 * 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.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev200120.evpn.EvpnChoice;
import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;

@NonNullByDefault
public interface EvpnSerializer {
    /**
     * Serialize Evpn.
     *
     * @param evpn   Evpn
     * @param buffer Encode common Evpn parts to output buffer
     * @return Encode Evpn to output buffer
     */
    ByteBuf serializeEvpn(EvpnChoice evpn, ByteBuf buffer);

    /**
     * Serialize Evpn Model.
     *
     * @param evpn ChoiceNode containing Evpn
     * @return Evpn
     */
    EvpnChoice serializeEvpnModel(ContainerNode evpn);

    /**
     * create Route key from Evpn model.
     *
     * @param evpn ContainerNode containing Evpn
     * @return Evpn
     */
    EvpnChoice createRouteKey(ContainerNode evpn);
}