Reliable Messaging API

The WSO2 WSF/PHP extension supports WS-ReliableMessaging protocol versions 1.0 and 1.1. One way messages as well as two way messages can be sent reliably.

You can use the following options to configure clients and services to use reliable messaging protocol.

WSClient Options for RM

Option Data Type Value Domain Default Value Description
reliable boolean | string | double TRUE | 1.0 | 1.1 Default RM version is 1.0 Defines whether to enable reliable messaging (RM) or not. If specified TRUE, then RM will be enabled with RM version as 1.0. For RM to be enabled, you must also set the addressing action.
sequenceExpiryTime int int  60 seconds The current sequence will expire in "sequenceExpiryTime" seconds from the current time.
sequenceKey string string none  The sequence key property
"willContinueSequence" boolean TRUE | FALSE FALSE Whether to continue the sequence. The sequence will be terminated by default if the user does not specify "willContinueSequence" => TRUE.


WSMessage Options for RM

Option Data Type Value Domain Default Value Description
lastMessage Boolean TRUE |  FALSE FALSE If the user wants to create multiple requests using the same sequence, this option can be used.
The client will check its "willContinueSequence" option. If it is FALSE (default value) , it will send a message and terminate the sequence. If the client's  "willContinueSequence" property is TRUE, it will check the "lastMessage" property of WSMessage. If the "lastMessage" is TRUE (default is FALSE) it will add the last message and terminate the sequence.


WSService Options for RM

Option Data Type Value Domain Default Value Description
reliable boolean FALSE | TRUE  FALSE When this option is specified, reliable messaging will be enabled for the corresponding service.