aboutsummaryrefslogtreecommitdiffstats
path: root/framework/src/onos/protocols/pcep/pcepio/src/main/java/org/onosproject/pcepio/protocol/PcepLabelRangeResvMsg.java
blob: 3e2a3a95452cd4db200e4bdb058368630166e823 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
/*
 * Copyright 2015 Open Networking Laboratory
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.onosproject.pcepio.protocol;

import org.jboss.netty.buffer.ChannelBuffer;
import org.onosproject.pcepio.exceptions.PcepParseException;

/**
 * Abstraction of an entity providing PCEP Label Range Reservation Message.
 */
public interface PcepLabelRangeResvMsg extends PcepObject, PcepMessage {

    @Override
    PcepVersion getVersion();

    @Override
    PcepType getType();

    /**
     * Returns LabelRange field in Label Range Reservation message.
     *
     * @return LabelRange field
     */
    PcepLabelRange getLabelRange();

    /**
     * Sets LabelRange field in Label Range Reservation message with specified value.
     *
     * @param lR label range object
     */
    void setLabelRange(PcepLabelRange lR);

    @Override
    void writeTo(ChannelBuffer channelBuffer) throws PcepParseException;

    /**
     * Builder interface with get and set functions to build Label Range Reservation message.
     */
    interface Builder extends PcepMessage.Builder {

        @Override
        PcepLabelRangeResvMsg build();

        @Override
        PcepVersion getVersion();

        @Override
        PcepType getType();

        /**
         * Returns LabelRange field in Label Range Reservation message.
         *
         * @return LabelRange object
         */
        PcepLabelRange getLabelRange();

        /**
         * Sets LabelRange field and returns its Builder.
         *
         * @param lR label range object
         * @return builder by setting LabelRange field
         */
        Builder setLabelRange(PcepLabelRange lR);
    }
}