bff72cddfdadf96f7a30795c3433e237152736f3
[bgpcep.git] / bgp / evpn / src / main / java / org / opendaylight / protocol / bgp / evpn / spi / EsiRegistry.java
1 /*
2  * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8
9 package org.opendaylight.protocol.bgp.evpn.spi;
10
11 import io.netty.buffer.ByteBuf;
12 import javax.annotation.Nonnull;
13 import javax.annotation.Nullable;
14 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.evpn.rev180329.esi.Esi;
15 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
16
17 public interface EsiRegistry {
18     /**
19      * Parse Esi.
20      *
21      * @param buffer encoded ESI body in Bytebuf
22      * @return Ethernet Segment Identifier
23      */
24     @Nullable
25     Esi parseEsi(@Nonnull ByteBuf buffer);
26
27     /**
28      * Parse Esi Model.
29      *
30      * @param esi ChoiceNode containing ESI
31      * @return Ethernet Segment Identifier
32      */
33     @Nullable
34     Esi parseEsiModel(@Nonnull ChoiceNode esi);
35
36     /**
37      * Serialize Esi.
38      *
39      * @param esi    Ethernet Segment Identifier
40      * @param buffer write in Bytebuf encoded ESI body
41      */
42     void serializeEsi(@Nonnull Esi esi, @Nonnull ByteBuf buffer);
43 }