[jboss-jira] [JBoss JIRA] (WFCORE-2780) Improve buffer-pool model description

[Romain Pelisse (JIRA)]

     [ https://issues.jboss.org/browse/WFCORE-2780?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Romain Pelisse updated WFCORE-2780:
-----------------------------------
    Description: 
Current state of buffer-pool model description:
{code}
[standalone at localhost:9990 /] /subsystem=io/buffer-pool=foo:read-resource-description
{             
    "outcome" => "success",
    "result" => {
        "description" => "Defines buffer pool",
        "capabilities" => [{
            "name" => "org.wildfly.io.buffer-pool",
            "dynamic" => true
        }],
        "attributes" => {
            "buffer-size" => {
                "type" => INT,
                "description" => "The size of each buffer slice in bytes, if not set optimal value is calculated based on available RAM resources in your system.",
                "expressions-allowed" => true,
                "required" => false,
                "nillable" => true,
                "access-type" => "read-write",
                "storage" => "configuration",
                "restart-required" => "all-services"
            },
            "buffers-per-slice" => {
                "type" => INT,
                "description" => "How many buffers per slice, if not set optimal value is calculated based on available RAM resources in your system.",
                "expressions-allowed" => true,
                "required" => false,
                "nillable" => true,
                "access-type" => "read-write",
                "storage" => "configuration",
                "restart-required" => "all-services"
            },
            "direct-buffers" => {
                "type" => BOOLEAN,
                "description" => "Does the buffer pool use direct buffers, some platforms don't support direct buffers",
                "expressions-allowed" => true,
                "required" => false,
                "nillable" => true,
                "access-type" => "read-write",
                "storage" => "configuration",
                "restart-required" => "all-services"
            }
        },
        "operations" => undefined,
        "notifications" => undefined,
        "children" => {}
    }
}
{code}

Following improvements should be done to it:

* In {{buffer-size}} and {{buffers-per-slice}} description there is mentioned something called 'slice'. Nowhere is described what it is. Suggested improvement: Explain what slice is, preferably in buffer-pool model description.
* In {{buffer-size}} and {{buffers-per-slice}} description there is this sentence: ''...if not set optimal value is calculated based on available RAM resources in your system" - how it is calculated? Is there any default fixed value? User would like to know this. Suggestion: Add explanation about default value.
* In {{direct-buffers}} description there is mentioned that some platforms don't support direct buffers? Is there mentioned which one or what determines whether direct buffers are supported on given platform? Suggested improvement: Explain what element determines whether direct buffers are supported.


> Improve buffer-pool model description
> -------------------------------------
>
>                 Key: WFCORE-2780
>                 URL: https://issues.jboss.org/browse/WFCORE-2780
>             Project: WildFly Core
>          Issue Type: Bug
>            Reporter: Romain Pelisse
>            Assignee: Romain Pelisse
>            Priority: Minor
>
> Current state of buffer-pool model description:
> {code}
> [standalone at localhost:9990 /] /subsystem=io/buffer-pool=foo:read-resource-description
> {             
>     "outcome" => "success",
>     "result" => {
>         "description" => "Defines buffer pool",
>         "capabilities" => [{
>             "name" => "org.wildfly.io.buffer-pool",
>             "dynamic" => true
>         }],
>         "attributes" => {
>             "buffer-size" => {
>                 "type" => INT,
>                 "description" => "The size of each buffer slice in bytes, if not set optimal value is calculated based on available RAM resources in your system.",
>                 "expressions-allowed" => true,
>                 "required" => false,
>                 "nillable" => true,
>                 "access-type" => "read-write",
>                 "storage" => "configuration",
>                 "restart-required" => "all-services"
>             },
>             "buffers-per-slice" => {
>                 "type" => INT,
>                 "description" => "How many buffers per slice, if not set optimal value is calculated based on available RAM resources in your system.",
>                 "expressions-allowed" => true,
>                 "required" => false,
>                 "nillable" => true,
>                 "access-type" => "read-write",
>                 "storage" => "configuration",
>                 "restart-required" => "all-services"
>             },
>             "direct-buffers" => {
>                 "type" => BOOLEAN,
>                 "description" => "Does the buffer pool use direct buffers, some platforms don't support direct buffers",
>                 "expressions-allowed" => true,
>                 "required" => false,
>                 "nillable" => true,
>                 "access-type" => "read-write",
>                 "storage" => "configuration",
>                 "restart-required" => "all-services"
>             }
>         },
>         "operations" => undefined,
>         "notifications" => undefined,
>         "children" => {}
>     }
> }
> {code}
> Following improvements should be done to it:
> * In {{buffer-size}} and {{buffers-per-slice}} description there is mentioned something called 'slice'. Nowhere is described what it is. Suggested improvement: Explain what slice is, preferably in buffer-pool model description.
> * In {{buffer-size}} and {{buffers-per-slice}} description there is this sentence: ''...if not set optimal value is calculated based on available RAM resources in your system" - how it is calculated? Is there any default fixed value? User would like to know this. Suggestion: Add explanation about default value.
> * In {{direct-buffers}} description there is mentioned that some platforms don't support direct buffers? Is there mentioned which one or what determines whether direct buffers are supported on given platform? Suggested improvement: Explain what element determines whether direct buffers are supported.



--
This message was sent by Atlassian JIRA
(v7.5.0#75005)