Management API Reference for transport=TCP_NIO2

The configuration of a transport for a protocol stack.

Children (1)

thread-pool
- default

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.clustering.jgroups.transport	true	/subsystem=jgroups/stack=/transport=UDP /subsystem=jgroups/stack=/transport=TCP /subsystem=jgroups/stack=/transport=

Attributes (9)

client-socket-binding - Defines an optional bind address/port of the socket used to send messages to other cluster members.

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Defines an optional bind address/port of the socket used to send messages to other cluster members.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.network.socket-binding", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : {"socket-binding-ref" : {"type" : "core"}}}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services" }

diagnostics-socket-binding - The diagnostics socket binding specification for this protocol layer, used to specify IP interfaces and ports for communication.

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The diagnostics socket binding specification for this protocol layer, used to specify IP interfaces and ports for communication.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.network.socket-binding", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : {"socket-binding-ref" : {"type" : "core"}}}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services" }

machine - The machine (i.e. host) identifier for this node. Used by Infinispan topology-aware consistent hash.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The machine (i.e. host) identifier for this node. Used by Infinispan topology-aware consistent hash.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

module - The module with which to resolve the protocol type.

Type	STRING
Default Value	org.jgroups
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The module with which to resolve the protocol type.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "org.jgroups", "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

properties - The properties of this protocol.

Type	OBJECT
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "The properties of this protocol.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

rack - The rack (i.e. server rack) identifier for this node. Used by Infinispan topology-aware consistent hash.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The rack (i.e. server rack) identifier for this node. Used by Infinispan topology-aware consistent hash.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

site - The site (i.e. data centre) identifier for this node. Used by Infinispan topology-aware consistent hash.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The site (i.e. data centre) identifier for this node. Used by Infinispan topology-aware consistent hash.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

socket-binding - Defines the bind address/port used of the server socket used to receive messages from other cluster members.

Type	STRING
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Defines the bind address/port used of the server socket used to receive messages from other cluster members.", "expressions-allowed" : false, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.network.socket-binding", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : {"socket-binding-ref" : {"type" : "core"}}}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services" }

statistics-enabled - Indicates whether or not this protocol will collect statistics overriding stack configuration.

Type	BOOLEAN
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Indicates whether or not this protocol will collect statistics overriding stack configuration.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

Operations (2)

add - Add the configuration of a transport for a protocol stack.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
client-socket-binding	STRING	false	false		Defines an optional bind address/port of the socket used to send messages to other cluster members.
diagnostics-socket-binding	STRING	false	false		The diagnostics socket binding specification for this protocol layer, used to specify IP interfaces and ports for communication.
machine	STRING	false	true		The machine (i.e. host) identifier for this node. Used by Infinispan topology-aware consistent hash.
module	STRING	false	true	org.jgroups	The module with which to resolve the protocol type.
properties	OBJECT	false	true		The properties of this protocol.
rack	STRING	false	true		The rack (i.e. server rack) identifier for this node. Used by Infinispan topology-aware consistent hash.
site	STRING	false	true		The site (i.e. data centre) identifier for this node. Used by Infinispan topology-aware consistent hash.
socket-binding	STRING	true	false		Defines the bind address/port used of the server socket used to receive messages from other cluster members.
statistics-enabled	BOOLEAN	false	true		Indicates whether or not this protocol will collect statistics overriding stack configuration.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add the configuration of a transport for a protocol stack.",
    "request-properties" : {
        "client-socket-binding" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Defines an optional bind address/port of the socket used to send messages to other cluster members.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.network.socket-binding",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "diagnostics-socket-binding" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The diagnostics socket binding specification for this protocol layer, used to specify IP interfaces and ports for communication.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.network.socket-binding",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "machine" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The machine (i.e. host) identifier for this node. Used by Infinispan topology-aware consistent hash.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "module" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The module with which to resolve the protocol type.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "org.jgroups",
            "stability" : "default"
        },
        "properties" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "The properties of this protocol.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "rack" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The rack (i.e. server rack) identifier for this node. Used by Infinispan topology-aware consistent hash.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "site" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The site (i.e. data centre) identifier for this node. Used by Infinispan topology-aware consistent hash.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "socket-binding" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Defines the bind address/port used of the server socket used to receive messages from other cluster members.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "capability-reference" : "org.wildfly.network.socket-binding",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "statistics-enabled" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Indicates whether or not this protocol will collect statistics overriding stack configuration.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Remove the configuration of a transport for a protocol stack.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Remove the configuration of a transport for a protocol stack.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "resource-services",
    "runtime-only" : false
}

Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

subsystem.jgroups.stack.transport.TCP_NIO2

        
<feature spec="subsystem.jgroups.stack.transport.TCP_NIO2">
  <param name="stack" value="{resource name}"/>
  <param name="client-socket-binding" value="{value}"/>
  <param name="diagnostics-socket-binding" value="{value}"/>
  <param name="machine" value="{value}"/>
  <param name="module" value="{value}"/>
  <param name="properties" value="{value}"/>
  <param name="rack" value="{value}"/>
  <param name="site" value="{value}"/>
  <param name="socket-binding" value="{value}"/>
  <param name="statistics-enabled" value="{value}"/>
<feature/>