ISessionModifyClientInfo Method

Allows the following client name and description properties of a Session to be modified after the Session has been created.

The property modifications can be carried out in a blocking or non-blocking mode, depending on the flag ModifyPropertyFlag Attempting to specify other Session properties will result in SOLCLIENT_FAIL being returned.

Note that only one outstanding client info modification request is allowed. Note that changing client name property would trigger the P2P topic changes. To avoid message loss, it is recommended that this API is used only at the initialization time.


Namespace: SolaceSystems.Solclient.Messaging
Assembly: SolaceSystems.Solclient.Messaging (in SolaceSystems.Solclient.Messaging.dll) Version: 10.24.0
ReturnCode ModifyClientInfo(
	SessionPropertiesPROPERTY sessionProperty,
	Object value,
	int flags,
	Object correlationKey


sessionProperty  SessionPropertiesPROPERTY
The property to modify.
value  Object
The new value for the property.
flags  Int32
One of the following flags: WaitForConfirm: if specified this call blocks the calling thread until a confirmation is received from the appliance (synchronous call).0: if 0 is specified, this method call will not block (asynchronous call).
correlationKey  Object
When specified (i.e. non null reference passed in), this correlationKey is returned in CorrelationKey - It is ignored if WaitForConfirm is specified.

Return Value

Throws OperationErrorException if failed. Otherwise it returns SOLCLIENT_WOULD_BLOCK if the operation cannot be accepted by the API immediately, SOLCLIENT_OK if successful, or SOLCLIENT_IN_PROGRESS if in progress.


OperationErrorException Thrown when the operation fails. Possible error subcodes include:
FatalErrorException Thrown when un-recoverable error occurs.
ObjectDisposedException Thrown when the session is already disposed (terminal state).
ArgumentNullException Thrown if any of the required parameters is null.

See Also