PcepClient (onos-providers-pcep-tunnel)

All Known Subinterfaces:

PcepClientDriver

All Known Implementing Classes:

PcepClientImpl
```
public interface PcepClient
```
Represents to provider facing side of a path computation client(pcc).

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addNode(PcepClient pc)` Adds PCEP device when session is successfully established.
`void`	`addSyncMsgToList(PccId pccId, PcepStateReport rptMsg)` Adds report message received during LSPDB sync into temporary cache.
`ClientCapability`	`capability()` Obtains capability supported by client.
`String`	`channelId()` Identifies the channel used to communicate with the pcc.
`Boolean`	`delegationInfo(LspKey lspKey)` Returns delegation flag for the given LSP info.
`void`	`deleteNode(PccId pccId)` Removes PCEP device when session is disconnected.
`void`	`disconnectClient()` Disconnects the pcc by closing the TCP connection.
`PcepFactory`	`factory()` Provides the factory for this PCEP version.
`PccId`	`getPccId()` Gets the ipAddress of the client.
`String`	`getStringId()` Gets a string version of the ID for this pcc.
`List<PcepStateReport>`	`getSyncMsgList(PccId pccId)` Returns the list of report messages received during LSPDB sync.
`void`	`handleMessage(PcepMessage fromClient)` Handle a message from the pcc.
`void`	`initializeSyncMsgList(PccId pccId)` Creates a temporary cache to hold report messages received during LSPDB sync.
`boolean`	`isConnected()` Checks if the pcc is still connected.
`boolean`	`isOptical()` Indicates if this pcc is optical.
`PcepSyncStatus`	`labelDbSyncStatus()` Indicates the label DB synchronization status of this pcc.
`PcepSyncStatus`	`lspDbSyncStatus()` Indicates the LSP state synchronization status of this pcc.
`void`	`removeSyncMsgList(PccId pccId)` Removes the list of report messages received during LSPDB sync.
`void`	`sendMessage(List<PcepMessage> msgs)` Writes the PcepMessage list to the driver.
`void`	`sendMessage(PcepMessage msg)` Writes the message to the driver.
`void`	`setCapability(ClientCapability capability)` Sets capability negotiated during open message exchange.
`void`	`setLabelDbSyncStatus(PcepSyncStatus syncStatus)` Sets the status of label DB synchronization.
`void`	`setLspAndDelegationInfo(LspKey lspKey, boolean dFlag)` Sets D flag for the given LSP and its LSP info.
`void`	`setLspDbSyncStatus(PcepSyncStatus syncStatus)` Sets the status of LSP state synchronization.

- Method Detail
  - sendMessage
```
void sendMessage(PcepMessage msg)
```
    Writes the message to the driver.
    
    Parameters:
    
    msg - the message to write
  - sendMessage
```
void sendMessage(List<PcepMessage> msgs)
```
    Writes the PcepMessage list to the driver.
    
    Parameters:
    
    msgs - the messages to be written
  - handleMessage
```
void handleMessage(PcepMessage fromClient)
```
    Handle a message from the pcc.
    
    Parameters:
    
    fromClient - the message to handle
  - factory
```
PcepFactory factory()
```
    Provides the factory for this PCEP version.
    
    Returns:
    
    PCEP version specific factory.
  - getStringId
```
String getStringId()
```
    Gets a string version of the ID for this pcc.
    
    Returns:
    
    string version of the ID
  - getPccId
```
PccId getPccId()
```
    Gets the ipAddress of the client.
    
    Returns:
    
    the client pccId in IPAddress format
  - isConnected
```
boolean isConnected()
```
    Checks if the pcc is still connected.
    
    Returns:
    
    true if client is connected, false otherwise
  - disconnectClient
```
void disconnectClient()
```
    Disconnects the pcc by closing the TCP connection. Results in a call to the channel handler's channelDisconnected method for cleanup.
  - isOptical
```
boolean isOptical()
```
    Indicates if this pcc is optical.
    
    Returns:
    
    true if optical
  - channelId
```
String channelId()
```
    Identifies the channel used to communicate with the pcc.
    
    Returns:
    
    string representation of the connection to the client
  - setLspDbSyncStatus
```
void setLspDbSyncStatus(PcepSyncStatus syncStatus)
```
    Sets the status of LSP state synchronization.
    
    Parameters:
    
    syncStatus - LSP synchronization status to be set
  - lspDbSyncStatus
```
PcepSyncStatus lspDbSyncStatus()
```
    Indicates the LSP state synchronization status of this pcc.
    
    Returns:
    
    LSP state synchronization status.
  - setLabelDbSyncStatus
```
void setLabelDbSyncStatus(PcepSyncStatus syncStatus)
```
    Sets the status of label DB synchronization.
    
    Parameters:
    
    syncStatus - label DB synchronization status to be set
  - labelDbSyncStatus
```
PcepSyncStatus labelDbSyncStatus()
```
    Indicates the label DB synchronization status of this pcc.
    
    Returns:
    
    label DB synchronization status.
  - setCapability
```
void setCapability(ClientCapability capability)
```
    Sets capability negotiated during open message exchange.
    
    Parameters:
    
    capability - supported by client
  - capability
```
ClientCapability capability()
```
    Obtains capability supported by client.
    
    Returns:
    
    capability supported by client
  - addNode
```
void addNode(PcepClient pc)
```
    Adds PCEP device when session is successfully established.
    
    Parameters:
    
    pc - PCEP client details
  - deleteNode
```
void deleteNode(PccId pccId)
```
    Removes PCEP device when session is disconnected.
    
    Parameters:
    
    pccId - PCEP client ID
  - setLspAndDelegationInfo
```
void setLspAndDelegationInfo(LspKey lspKey,
                             boolean dFlag)
```
    Sets D flag for the given LSP and its LSP info.
    
    Parameters:
    
    lspKey - contains LSP info
    
    dFlag - delegation flag in LSP object
  - delegationInfo
```
Boolean delegationInfo(LspKey lspKey)
```
    Returns delegation flag for the given LSP info.
    
    Parameters:
    
    lspKey - contains LSP info
    
    Returns:
    
    delegation flag
  - initializeSyncMsgList
```
void initializeSyncMsgList(PccId pccId)
```
    Creates a temporary cache to hold report messages received during LSPDB sync.
    
    Parameters:
    
    pccId - PCC id which is the key to store report messages
  - getSyncMsgList
```
List<PcepStateReport> getSyncMsgList(PccId pccId)
```
    Returns the list of report messages received during LSPDB sync.
    
    Parameters:
    
    pccId - PCC id which is the key for all the report messages
    
    Returns:
    
    list of report messages received during LSPDB sync
  - removeSyncMsgList
```
void removeSyncMsgList(PccId pccId)
```
    Removes the list of report messages received during LSPDB sync.
    
    Parameters:
    
    pccId - PCC id which is the key for all the report messages
  - addSyncMsgToList
```
void addSyncMsgToList(PccId pccId,
                      PcepStateReport rptMsg)
```
    Adds report message received during LSPDB sync into temporary cache.
    
    Parameters:
    
    pccId - PCC id which is the key to store report messages
    
    rptMsg - the report message to be stored

Interface PcepClient

Method Summary

Method Detail

sendMessage

sendMessage

handleMessage

factory

getStringId

getPccId

isConnected

disconnectClient

isOptical

channelId

setLspDbSyncStatus

lspDbSyncStatus

setLabelDbSyncStatus

labelDbSyncStatus

setCapability

capability

addNode

deleteNode

setLspAndDelegationInfo

delegationInfo

initializeSyncMsgList

getSyncMsgList

removeSyncMsgList

addSyncMsgToList