pcep/spi/src/main/java/org/opendaylight/protocol/pcep/spi/MessageRegistry.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
  12 import java.util.List;
  13
  14 import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev131005.Message;
  15
  16 public interface MessageRegistry {
  17     /**
  18      * Finds parser for given message type in the registry. Delegates parsing to found parser.
  19      *
  20      * @param messageType message type, key in parser registry
  21      * @param buffer message wrapped in ByteBuf
  22      * @param errors list of error messages, that is filled during parsing
  23      * @return null if the parser for this message could not be found
  24      * @throws PCEPDeserializerException if the parsing did not succeed
  25      */
  26     Message parseMessage(final int messageType, final ByteBuf buffer, final List<Message> errors) throws PCEPDeserializerException;
  27
  28     /**
  29      * Find serializer for given message. Delegates parsing to found serializer.
  30      *
  31      * @param message to be parsed
  32      * @param buffer byte buffer that will be filled with serialized message
  33      */
  34     void serializeMessage(final Message message, final ByteBuf buffer);
  35 }