doc: @Blocking #7228
doc: @Blocking #7228
Conversation
|
I don't think we should document @Blocking as it relates to controller routes because |
I’m OK with that either way. I already have a PR that removes the other [obsolete] mention of it in core docs. If we want to deprecate its use and not mention in in the user guide, should we meta-annotate it |
|
I think we should document it. I don't think we should not document a feature just because we plan to remove it. |
|
@wetted I have changed the copy. Let me know if you are ok with the changes. |
sdelamo
force-pushed
the
Issue7183-document-blocking
branch
from
ee39dc1
to
2c2f3d0
Compare
|
@sdelamo yes, thanks for improving/correcting/clarifying. Looks good now. |
|
@graemerocher please review it when you can. |
|
|
||
| If you set `micronaut.server.thread-selection` to `AUTO`, The Micronaut Framework offloads the execution of methods annotated with `@Blocking` to the IO thread pool (See: api:io.micronaut.scheduling.TaskExecutors[]). | ||
|
|
||
| NOTE: `@Blocking` only works if you are using `AUTO` thread selection. Micronaut Framework defaults to `MANUAL` thread selection since Micronaut 2.0. We recommend the usage of ann:scheduling.annotation.ExecuteOn[] annotation to execute the blocking operations on a different thread. `@ExecutesOn` works for both `MANUAL` or `AUTO` thread selection. |
There was a problem hiding this comment.
| NOTE: `@Blocking` only works if you are using `AUTO` thread selection. Micronaut Framework defaults to `MANUAL` thread selection since Micronaut 2.0. We recommend the usage of ann:scheduling.annotation.ExecuteOn[] annotation to execute the blocking operations on a different thread. `@ExecutesOn` works for both `MANUAL` or `AUTO` thread selection. | |
| NOTE: `@Blocking` only works if you are using `AUTO` thread selection. Micronaut defaults to `MANUAL` thread selection since Micronaut 2.0. We recommend the usage of ann:scheduling.annotation.ExecuteOn[] annotation to execute the blocking operations on a different thread pool. `@ExecutesOn` works for both `MANUAL` and `AUTO` thread selection. |
There was a problem hiding this comment.
Micronaut should not be used as a noun to match the brand guidelines. Hence, the Micronaut Framework
There was a problem hiding this comment.
I have incorporated most of your suggestions here: e33ddf1
There was a problem hiding this comment.
There are gazillion places where simply "Micronaut" is used. Enforcing "Micronaut Framework" in every occurrence in the documentation is quite inappropriate, to say the least.
src/main/docs/guide/httpServer/serverConfiguration/threadPools/atBlocking.adoc
Outdated
Show resolved
Hide resolved
src/main/docs/guide/httpServer/serverConfiguration/threadPools/atBlocking.adoc
Outdated
Show resolved
Hide resolved
src/main/docs/guide/httpServer/serverConfiguration/threadPools/atBlocking.adoc
Outdated
Show resolved
Hide resolved
…/atBlocking.adoc Co-authored-by: Álvaro Sánchez-Mariscal <alvaro.sanchez-mariscal@oracle.com>
…/atBlocking.adoc Co-authored-by: Álvaro Sánchez-Mariscal <alvaro.sanchez-mariscal@oracle.com>
…/atBlocking.adoc Co-authored-by: Álvaro Sánchez-Mariscal <alvaro.sanchez-mariscal@oracle.com>
|
|
|
Kudos, SonarCloud Quality Gate passed!
|
Closes #7183