pcep/spi/src/main/java/org/opendaylight/protocol/pcep/spi/EROSubobjectRegistry.java

   1 /*
   2  * Copyright (c) 2013 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 package org.opendaylight.protocol.pcep.spi;
   9
  10 import io.netty.buffer.ByteBuf;
  11 import org.opendaylight.protocol.pcep.PCEPDeserializerException;
  12 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.explicit.route.object.ero.Subobject;
  13
  14 /**
  15  * Explicit Route Object Registry.
  16  */
  17 public interface EROSubobjectRegistry {
  18     /**
  19      * Finds parser for given subobject type in the registry. Delegates parsing to found parser.
  20      *
  21      * @param subobjectType subobject type, key in parser registry
  22      * @param buffer        subobject wrapped in ByteBuf
  23      * @param loose         ERO specific common field
  24      * @return null if the parser for this subobject could not be found
  25      * @throws PCEPDeserializerException if the parsing did not succeed
  26      */
  27     Subobject parseSubobject(int subobjectType, ByteBuf buffer, boolean loose) throws PCEPDeserializerException;
  28
  29     /**
  30      * Find serializer for given subobject. Delegates parsing to found serializer.
  31      *
  32      * @param subobject to be parsed
  33      * @param buffer    buffer where the serialized subobject will be parsed
  34      */
  35     void serializeSubobject(Subobject subobject, ByteBuf buffer);
  36 }