cactus-agent/src/api/ws/cactus_plots_create/README.md

cactus rpc/websocket client library

# Websocket Message from Plotting service

### `on_message_from_cactus_plots_create`
Capture all broadcast messages coming from `cactus_plots_create` service.

#### Usage
You need to create Websocket connection before subscribing websocket messages.  
```js
const {getDaemon} = require("cactus-agent");
const {on_message_from_cactus_plots_create} = require("cactus-agent/api/ws");

const daemon = getDaemon(); // This is the websocket connection handler
await daemon.connect(); // connect to local daemon using config file.

// Capture all messages from `cactus_plots_create`
const unsubscribe = await on_message_from_cactus_plots_create(daemon, (event) => {
  console.log(e.data);

  // Close connection if you don't need it anymore.
  if(...){
    unsubscribe(); // stop listening to this ws message.
  }
});
...
```

---

### `on_state_changed_of_plots`
Capture broadcast message of command `state_changed` from `cactus_plots_create` service.

#### Usage
```typescript
const {getDaemon} = require("cactus-agent");
const {on_state_changed_of_plots} = require("cactus-agent/api/ws");

const daemon = getDaemon();
await daemon.connect();
const unsubscribe = await on_state_changed_of_plots(daemon, (event) => {
  // Format of `event` object is described below.
  ...
});
...
unsubscribe(); // Stop subscribing messages
```
#### event:
```typescript
{
  origin: "cactus_plotter";
  command: "state_changed";
  ack: boolean;
  data: /*See below*/;
  request_id: string;
  destination: "wallet_ui";
}
```
#### data:
```typescript
{
  state: "log_changed"|"state_changed";
  queue: Array<{
    id: str;
    queue: str;
    size: int;
    parallel: bool;
    delay: int;
    state: str;
    error: Optional<str>;
    deleted: bool;
    log_new: str;
    log?: str;
  }>;
}
```