DebugClientHandler (Ballerina - Core 0.970.0-beta18 API)

All Known Implementing Classes:

VMDebugClientHandler
```
public interface DebugClientHandler
```
Represents a debug client handler which is used to communicate with the debug client.

Since:

0.95.4

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addWorkerContext(WorkerExecutionContext ctx)` Called when adding a context.
`void`	`clearChannel()` Method to remove web socket channel.
`Map<String,WorkerExecutionContext>`	`getAllWorkerContexts()` Method to get all worker contexts.
`WorkerExecutionContext`	`getWorkerContext(String workerId)` Method to get worker context given the workerId.
`boolean`	`isChannelActive()` Method to check whether channel is active or not.
`void`	`notifyExit()` Called when main program exit.
`void`	`notifyHalt(MessageDTO message)` Called when executor hits a break point.
`void`	`sendCustomMsg(MessageDTO message)` Send a custom message to the client.
`void`	`setChannel(io.netty.channel.Channel channel)` Method to set web socket channel required for communication.

- Method Detail
  - addWorkerContext
```
void addWorkerContext(WorkerExecutionContext ctx)
```
    Called when adding a context.
    
    Parameters:
    
    ctx - to be added to the map.
  - getWorkerContext
```
WorkerExecutionContext getWorkerContext(String workerId)
```
    Method to get worker context given the workerId.
    
    Parameters:
    
    workerId - of the thread.
    
    Returns:
    
    worker context.
  - getAllWorkerContexts
```
Map<String,WorkerExecutionContext> getAllWorkerContexts()
```
    Method to get all worker contexts.
    
    Returns:
    
    methodContext map.
  - setChannel
```
void setChannel(io.netty.channel.Channel channel)
         throws DebugException
```
    Method to set web socket channel required for communication.
    
    Parameters:
    
    channel - required for communication.
    
    Throws:
    
    DebugException - in case of failure.
  - clearChannel
```
void clearChannel()
```
    Method to remove web socket channel.
  - isChannelActive
```
boolean isChannelActive()
```
    Method to check whether channel is active or not.
    
    Returns:
    
    true if active.
  - notifyExit
```
void notifyExit()
```
    Called when main program exit.
  - notifyHalt
```
void notifyHalt(MessageDTO message)
```
    Called when executor hits a break point.
    
    Parameters:
    
    message - to send to the client.
  - sendCustomMsg
```
void sendCustomMsg(MessageDTO message)
```
    Send a custom message to the client.
    
    Parameters:
    
    message - message to send to the client

Interface DebugClientHandler

Method Summary

Method Detail

addWorkerContext

getWorkerContext

getAllWorkerContexts

setChannel

clearChannel

isChannelActive

notifyExit

notifyHalt

sendCustomMsg