diff --git a/webapps/docs/cluster-howto.xml b/webapps/docs/cluster-howto.xml index cc753422e19f..cbab6fddc798 100644 --- a/webapps/docs/cluster-howto.xml +++ b/webapps/docs/cluster-howto.xml @@ -238,6 +238,18 @@ should be completed:

replication yields shorter request times, and synchronous replication guarantees the session to be replicated before the request returns.

+

+ In addition to channelSendOptions, the backup manager's + mapSendOptions attribute uses the same send-option flag + mechanism. This attribute controls how the replicated map within the + BackupManager sends its messages during session backup + operations. + Just like channelSendOptions, the value may be specified + either as an integer bitmask (e.g. 6) or using the + human-readable option names (e.g. "sync,use_ack"), with + multiple names separated by commas. The same option names and flag + combinations apply to both attributes. +

diff --git a/webapps/docs/config/cluster-manager.xml b/webapps/docs/config/cluster-manager.xml index 6197baa47a9f..dc9279363295 100644 --- a/webapps/docs/config/cluster-manager.xml +++ b/webapps/docs/config/cluster-manager.xml @@ -227,12 +227,44 @@ - The backup manager uses a replicated map, this map is sending and - receiving messages. You can setup the flag for how this map is sending - messages, the default value is 6(synchronous).
- Note that if you use asynchronous messaging it is possible for update - messages for a session to be processed by the receiving node in a - different order to the order in which they were sent. +

+ The backup manager uses a replicated map. This map sends and receives + messages internally. You can configure the flag that controls how this + map sends messages. The default value is 6 (synchronous).
+ Note that if you use asynchronous messaging it is possible for update + messages for a session to be processed by the receiving node in a + different order to the order in which they were sent. +

+ +

+ The value may be specified either as an integer flag or using the + human-readable option names. These names are translated to their integer + values on startup. +

+ +

Some of the values are:
+ Channel.SEND_OPTIONS_SYNCHRONIZED_ACK = 0x0004
+ Channel.SEND_OPTIONS_ASYNCHRONOUS = 0x0008
+ Channel.SEND_OPTIONS_USE_ACK = 0x0002
+ Therefore, the default 6 corresponds to + sync,use_ack (4 + 2). +

+ +

+ Examples:
+ mapSendOptions="6" / + mapSendOptions="sync,use_ack"
+ mapSendOptions="8" / mapSendOptions="async"
+ mapSendOptions="2" / mapSendOptions="use_ack" +

+ +

+ The valid option names are the same as for channelSendOptions: + "asynchronous" (alias "async"), "byte_message" (alias "byte"), + "multicast", "secure", "synchronized_ack" (alias "sync"), "udp", + "use_ack". Multiple names may be comma-separated, e.g. + "async,multicast". +

The maximum number of active sessions that will be created by this diff --git a/webapps/docs/config/cluster-valve.xml b/webapps/docs/config/cluster-valve.xml index c353053afb6f..2cdf68d40ae7 100644 --- a/webapps/docs/config/cluster-valve.xml +++ b/webapps/docs/config/cluster-valve.xml @@ -131,7 +131,40 @@ map sends messages. The default value is 6 (synchronous). Note that if you use asynchronous messaging it is possible for update messages to be processed by the receiving node in a different order to - the order in which they were sent.

+ the order in which they were sent. +

+ +

+ The value may be specified either as an integer flag or using the + human-readable option names. These names are translated to their + integer values on startup. +

+ +

Some of the values are:
+ Channel.SEND_OPTIONS_SYNCHRONIZED_ACK = 0x0004
+ Channel.SEND_OPTIONS_ASYNCHRONOUS = 0x0008
+ Channel.SEND_OPTIONS_USE_ACK = 0x0002
+ Therefore, the default 6 corresponds to + sync,use_ack (4 + 2). +

+ +

+ Examples:
+ mapSendOptions="6" / + mapSendOptions="sync,use_ack"
+ mapSendOptions="8" / + mapSendOptions="async"
+ mapSendOptions="2" / + mapSendOptions="use_ack" +

+ +

+ The valid option names are the same as for + channelSendOptions: "asynchronous" (alias "async"), + "byte_message" (alias "byte"), "multicast", "secure", + "synchronized_ack" (alias "sync"), "udp", "use_ack". Multiple names + may be comma-separated, e.g. "async,multicast". +

Default false. Flag to determine whether each request needs to be