blob: 95e7789fa50a7d376741a3bbc231678f338e98e9 (
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
/*
* 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.pcep.controller;
import java.util.List;
import org.onosproject.pcepio.protocol.PcepFactory;
import org.onosproject.pcepio.protocol.PcepMessage;
/**
* Represents to provider facing side of a path computation client(pcc).
*/
public interface PcepClient {
/**
* Writes the message to the driver.
*
* @param msg the message to write
*/
void sendMessage(PcepMessage msg);
/**
* Writes the PcepMessage list to the driver.
*
* @param msgs the messages to be written
*/
void sendMessage(List<PcepMessage> msgs);
/**
* Handle a message from the pcc.
*
* @param fromClient the message to handle
*/
void handleMessage(PcepMessage fromClient);
/**
* Provides the factory for this PCEP version.
*
* @return PCEP version specific factory.
*/
PcepFactory factory();
/**
* Gets a string version of the ID for this pcc.
*
* @return string version of the ID
*/
String getStringId();
/**
* Gets the ipAddress of the client.
*
* @return the client pccId in IPAddress format
*/
PccId getPccId();
/**
* Checks if the pcc is still connected.
*
* @return true if client is connected, false otherwise
*/
boolean isConnected();
/**
* Disconnects the pcc by closing the TCP connection. Results in a call
* to the channel handler's channelDisconnected method for cleanup.
*/
void disconnectClient();
/**
* Indicates if this pcc is optical.
*
* @return true if optical
*/
boolean isOptical();
/**
* Identifies the channel used to communicate with the pcc.
*
* @return string representation of the connection to the client
*/
String channelId();
/**
* To set the status of state synchronization.
*
* @param value to set the synchronization status
*/
void setIsSyncComplete(boolean value);
/**
* Indicates the state synchronization status of this pcc.
*
* @return true/false if the synchronization is completed/not completed
*/
boolean isSyncComplete();
}
|
