DISPATCH-1624: doc max message size. This closes #729.
diff --git a/docs/books/modules/user-guide/creating-vhost-policies.adoc b/docs/books/modules/user-guide/creating-vhost-policies.adoc
index 7f61ef9..7849382 100644
--- a/docs/books/modules/user-guide/creating-vhost-policies.adoc
+++ b/docs/books/modules/user-guide/creating-vhost-policies.adoc
@@ -32,7 +32,7 @@
.Procedure
-. Add a `vhost` section and define the connection limits for the messaging endpoint.
+. Add a `vhost` section and define the connection and message size limits for the messaging endpoint.
+
--
The connection limits apply to all users that are connected to the vhost. These limits control the number of users that can be connected simultaneously to the vhost.
@@ -42,6 +42,7 @@
vhost {
hostname: example.com
maxConnections: 10000
+ maxMessageSize: 500000
maxConnectionsPerUser: 100
maxConnectionsPerHost: 100
allowUnknownUser: true
@@ -56,6 +57,9 @@
`maxConnections`::
The global maximum number of concurrent client connections allowed for this vhost. The default is 65535.
+`maxMessageSize`::
+The maximum size in bytes of AMQP message transfers allowed for connections to this vhost. This limit overrides the policy `maxMessageSize` value and may be overridden by vhost user group settings. A value of `0` disables this limit.
+
`maxConnectionsPerUser`::
The maximum number of concurrent client connections allowed for any user. The default is 65535.
@@ -112,6 +116,9 @@
`maxConnectionsPerHost`::
The maximum number of concurrent connections that may be created by users in this user group from any of the permitted remote hosts. This value, if specified, overrides the vhost `maxConnectionsPerUser` value.
+`maxMessageSize`::
+The maximum size in bytes of AMQP message transfers allowed for connections created by users in this group. This limit overrides the policy and vhost `maxMessageSize` values. A value of `0` disables this limit.
+
`allowDynamicSource`::
If `true`, connections from users in this group are permitted to attach receivers to dynamic sources. This permits creation of listeners to temporary addresses or temporary queues. If `false`, use of dynamic sources is not permitted.
diff --git a/docs/books/modules/user-guide/setting-global-connection-limits.adoc b/docs/books/modules/user-guide/setting-global-connection-limits.adoc
index 5001431..961a77c 100644
--- a/docs/books/modules/user-guide/setting-global-connection-limits.adoc
+++ b/docs/books/modules/user-guide/setting-global-connection-limits.adoc
@@ -22,23 +22,27 @@
// authorizing-access-messaging-resources.adoc
[id='setting-global-connection-limits-{context}']
-= Setting global connection limits
+= Setting global limits
-You can create a global policy to set the incoming connection limit for a router. This limit defines the total number of concurrent client connections that can be open for this router.
+You can create a global policy to set the incoming connection and message size limits for a router.
.Procedure
-* In the `{RouterConfigFile}` configuration file, add a `policy` section and set the `maxConnections`.
+* In the `{RouterConfigFile}` configuration file, add a `policy` section and set the limits.
+
--
-This example sets the incoming connection limit to 10000:
+This example sets the incoming connection limit and message size:
[options="nowrap",subs="+quotes"]
----
policy {
maxConnections: 10000
+ maxMessageSize: 500000
}
----
`maxConnections`::
-This limit is always enforced, even if no other policy settings have been defined. The limit is applied to all incoming connections regardless of remote host, authenticated user, or targeted vhost. The default (and the maximum) value is `65535`.
+The total number of concurrent client connections that can be open for this router. This limit is always enforced, even if no other policy settings have been defined. The limit is applied to all incoming connections regardless of remote host, authenticated user, or targeted vhost. The default (and the maximum) value is `65535`.
+
+`maxMessageSize`::
+The maximum size in bytes of AMQP message transfers allowed for this router. This limit is applied only to transfers over user connections and is not applied to inter-router or edge router connections. This limit may be overridden by vhost or by vhost user group settings. A value of `0` disables this limit.
--
