Skip to content

Commit be7f023

Browse files
committed
doc: document AddChannel/RemoveChannel
Signed-off-by: René Jochum <rene@jochum.dev>
1 parent e757cb6 commit be7f023

1 file changed

Lines changed: 6 additions & 3 deletions

File tree

doc/events.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,10 @@ disconnected are not resent.
2323

2424
When using the Go client, handlers registered through `AddHandler` are called concurrently and may therefore observe
2525
events out of order. Use `AddChannel` instead to receive the events on a channel, which delivers them one at a time and
26-
in the order they arrived. The channel is closed once the listener is done, so it can be consumed with a `range` loop.
26+
in the order they arrived, and is closed once the listener ends. Its size argument sets how far behind the reader may
27+
fall before the listener is dropped.
28+
29+
Use `RemoveChannel` to stop receiving on one channel without disconnecting the whole listener.
2730

2831
## Event structure
2932

@@ -98,8 +101,8 @@ type: lifecycle
98101
| `image-alias-deleted` | An alias has been deleted for an existing image. | `target`: the original instance. |
99102
| `image-alias-renamed` | The alias for an existing image has been renamed. | `old_name`: the previous name. |
100103
| `image-alias-updated` | The configuration for an image alias has changed. | `target`: the original instance. |
101-
| `instance-agent-started` | The instance agent has connected to the host. | |
102-
| `instance-agent-stopped` | The instance agent has disconnected from the host. | |
104+
| `instance-agent-started` | The instance agent has connected to the host. | |
105+
| `instance-agent-stopped` | The instance agent has disconnected from the host. | |
103106
| `image-created` | A new image has been added to the image store. | `type`: `container` or `vm`. |
104107
| `image-deleted` | The image has been deleted from the image store. | |
105108
| `image-refreshed` | The local image copy has updated to the current source image version. | |

0 commit comments

Comments
 (0)