Jian Li | 26069e2 | 2016-08-10 22:00:52 +0900 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2016-present Open Networking Laboratory |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | package org.onosproject.lisp.msg.protocols; |
| 17 | |
| 18 | import io.netty.buffer.ByteBuf; |
Yoonseon Han | ca814bf | 2016-09-12 11:37:48 -0700 | [diff] [blame] | 19 | import org.onlab.packet.DeserializationException; |
Jian Li | 26069e2 | 2016-08-10 22:00:52 +0900 | [diff] [blame] | 20 | import org.onosproject.lisp.msg.exceptions.LispParseError; |
Jian Li | a7b394d | 2016-08-21 23:11:46 +0900 | [diff] [blame] | 21 | import org.onosproject.lisp.msg.exceptions.LispReaderException; |
Jian Li | 26069e2 | 2016-08-10 22:00:52 +0900 | [diff] [blame] | 22 | |
| 23 | /** |
| 24 | * An interface for de-serializing LISP control message. |
| 25 | */ |
| 26 | public interface LispMessageReader<T> { |
| 27 | |
| 28 | /** |
| 29 | * Reads from byte buffer and de-serialize the LISP control message. |
| 30 | * |
| 31 | * @param byteBuf byte buffer |
| 32 | * @return LISP message instance |
Yoonseon Han | ca814bf | 2016-09-12 11:37:48 -0700 | [diff] [blame] | 33 | * @throws LispParseError if the requested message cannot be parsed |
| 34 | * as a LISP object |
| 35 | * @throws LispReaderException if LISP message reader cannot process |
| 36 | * the received message |
| 37 | * @throws DeserializationException if an inner IP header (IPv4 or IPv6) |
| 38 | * cannot be deserialized due to the message not match |
| 39 | * with IP header format |
Jian Li | 26069e2 | 2016-08-10 22:00:52 +0900 | [diff] [blame] | 40 | */ |
Yoonseon Han | ca814bf | 2016-09-12 11:37:48 -0700 | [diff] [blame] | 41 | T readFrom(ByteBuf byteBuf) throws LispParseError, LispReaderException, |
| 42 | DeserializationException; |
Jian Li | 26069e2 | 2016-08-10 22:00:52 +0900 | [diff] [blame] | 43 | } |