Add documentation of interceptors to README #970
Conversation
400c5a9 to
64121d6
Compare
64121d6 to
8232d0d
Compare
README.md
Outdated
| that you wish to use to effect your modifications. Then, pass a list containing an instance of your `worker.Interceptor` | ||
| class as the `interceptors` argument of `Client.connect()`. |
There was a problem hiding this comment.
pass a list containing an instance of your
worker.Interceptorclass as theinterceptorsargument ofClient.connect().
Only client interceptors should be passed to client connect. If it also implements worker interceptor, then that ends up applying to worker too, but you can't just pass worker interceptors to client connect.
There was a problem hiding this comment.
Ah thanks, yes that section wasn't quite there. I've pushed an update.
README.md
Outdated
| that you wish to use to effect your modifications. Then, pass a list containing an instance of your `worker.Interceptor` | ||
| class as the `interceptors` argument of `Client.connect()`. | ||
|
|
||
| You can also pass worker interceptors as the `interceptor` argument to the |
There was a problem hiding this comment.
| You can also pass worker interceptors as the `interceptor` argument to the | |
| You can also pass worker interceptors as the `interceptors` argument to the |
|
|
||
| 1. Outbound client calls, such as `start_workflow()`, `signal_workflow()`, `list_workflows()`, `update_schedule()`, etc. | ||
|
|
||
| 2. Inbound workflow calls: `execute_workflow()`, `handle_signal()`, `handle_update_handler()`, etc |
There was a problem hiding this comment.
Ug, I just realized we called it handle_update_handler instead of handle_update here, oh well too late to change now
There was a problem hiding this comment.
That was a deliberate design decision -- to match handle_update_validator(). Pretty sure you were involved in that decision.
There was a problem hiding this comment.
I would personally have preferred handle_update()
There was a problem hiding this comment.
K, yeah I guess I regret my choice here if that is what happened. Luckily I didn't replicate it in .NET or Ruby.
README.md
Outdated
|
|
||
| 4. Inbound call to execute an activity: `execute_activity()` | ||
|
|
||
| 5. Outbound activity calls: `info()` and `hearbeat()` |
There was a problem hiding this comment.
| 5. Outbound activity calls: `info()` and `hearbeat()` | |
| 5. Outbound activity calls: `info()` and `heartbeat()` |
rendered