Class DockerNetworkHandler

Process handler for Docker networks

Hierarchy

DockerNetworkHandler

Implements

ProcessHandler

Index

Constructors

constructor

Properties

network

Methods

Constructors

constructor

new DockerNetworkHandler(network: Network): DockerNetworkHandler

- Defined in packages/jbr/lib/docker/DockerNetworkHandler.ts:10
Parameters
- network: Network
Returns DockerNetworkHandler

Properties

Readonly network

network: Network

Methods

addTerminationHandler

addTerminationHandler(handler: (processName: string, error?: Error) => void): void

Implementation of ProcessHandler.addTerminationHandler
- Defined in packages/jbr/lib/docker/DockerNetworkHandler.ts:28
Register a termination handler.

Parameters
- handler: (processName: string, error?: Error) => void
  - - (processName: string, error?: Error): void
    - Parameters
      - processName: string
      - Optional error: Error
      Returns void
Returns void

close

close(): Promise<void>

Implementation of ProcessHandler.close
- Defined in packages/jbr/lib/docker/DockerNetworkHandler.ts:14
Stop and clean this process.

Returns Promise<void>

join

join(): Promise<void>

Implementation of ProcessHandler.join
- Defined in packages/jbr/lib/docker/DockerNetworkHandler.ts:18
Wait until this container is ended.

Returns Promise<void>

removeTerminationHandler

removeTerminationHandler(handler: (processName: string, error?: Error) => void): void

Implementation of ProcessHandler.removeTerminationHandler
- Defined in packages/jbr/lib/docker/DockerNetworkHandler.ts:32
Remove a termination listener.

Parameters
- handler: (processName: string, error?: Error) => void
  - - (processName: string, error?: Error): void
    - Parameters
      - processName: string
      - Optional error: Error
      Returns void
Returns void

startCollectingStats

startCollectingStats(): Promise<() => void>

Implementation of ProcessHandler.startCollectingStats
- Defined in packages/jbr/lib/docker/DockerNetworkHandler.ts:22
Start collecting runtime statistics into the target stats file. The returned callback is used to end stat collection.

Returns Promise<() => void>

Generated using TypeDoc