Skip to content

Commit 2ccf3a4

Browse files
committed
FQCNs in usage instructions
1 parent 47b33c4 commit 2ccf3a4

2 files changed

Lines changed: 4 additions & 4 deletions

File tree

README.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@ Currently, LRPM is not intended to run as PID 1, nor was it tested in this role.
4242

4343
== Usage
4444

45-
1. Implement one or more `Worker` classes. This interface exposes two public methods, `start()` and `cycle()`. The child process will call `start()`, passing the worker configuration as an argument, and then enter an endless loop, where it calls `cycle()`, and then checks for a shutdown condition (usually, the termination of the LRPM supervisor process). Backoff should be implemented at the end of the `cycle()` method, as we dispatch signal handlers right after `cycle()` returns. Be careful not to run a tight loop at times when cycles are not doing actual work!
46-
2. Implement the `ConfigurationSource` class. This interface exposes a public method `loadConfiguration()`, that returns an associative array containing the configuration for all the workers (see example and full documentation in the `Job configuration` subsection).
45+
1. Implement one or more `Worker` classes. The `PHPLRPM\Worker` interface exposes two public methods, `start()` and `cycle()`. The child process will call `start()`, passing the worker configuration as an argument, and then enter an endless loop, where it calls `cycle()`, and then checks for a shutdown condition (usually, the termination of the LRPM supervisor process). Backoff should be implemented at the end of the `cycle()` method, as we dispatch signal handlers right after `cycle()` returns. Be careful not to run a tight loop at times when cycles are not doing actual work!
46+
2. Implement the `ConfigurationSource` class. The `PHPLRPM\ConfigurationSource` interface exposes a public method `loadConfiguration()`, that returns an associative array containing the configuration for all the workers (see example and full documentation in the `Job configuration` subsection).
4747
3. Run `bin/rlpm` with your configuration class as an argument, e.g. `bin/rlpm '\MyNamespace\MyConfigurationSource'`
4848

4949
=== Job configuration

README.in.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@ Currently, LRPM is not intended to run as PID 1, nor was it tested in this role.
4242

4343
== Usage
4444

45-
1. Implement one or more `Worker` classes. This interface exposes two public methods, `start()` and `cycle()`. The child process will call `start()`, passing the worker configuration as an argument, and then enter an endless loop, where it calls `cycle()`, and then checks for a shutdown condition (usually, the termination of the LRPM supervisor process). Backoff should be implemented at the end of the `cycle()` method, as we dispatch signal handlers right after `cycle()` returns. Be careful not to run a tight loop at times when cycles are not doing actual work!
46-
2. Implement the `ConfigurationSource` class. This interface exposes a public method `loadConfiguration()`, that returns an associative array containing the configuration for all the workers (see example and full documentation in the `Job configuration` subsection).
45+
1. Implement one or more `Worker` classes. The `PHPLRPM\Worker` interface exposes two public methods, `start()` and `cycle()`. The child process will call `start()`, passing the worker configuration as an argument, and then enter an endless loop, where it calls `cycle()`, and then checks for a shutdown condition (usually, the termination of the LRPM supervisor process). Backoff should be implemented at the end of the `cycle()` method, as we dispatch signal handlers right after `cycle()` returns. Be careful not to run a tight loop at times when cycles are not doing actual work!
46+
2. Implement the `ConfigurationSource` class. The `PHPLRPM\ConfigurationSource` interface exposes a public method `loadConfiguration()`, that returns an associative array containing the configuration for all the workers (see example and full documentation in the `Job configuration` subsection).
4747
3. Run `bin/rlpm` with your configuration class as an argument, e.g. `bin/rlpm '\MyNamespace\MyConfigurationSource'`
4848

4949
=== Job configuration

0 commit comments

Comments
 (0)