ISession.ModifyClientInfo Method

Solclient

previous page next page

Solclient

ISessionModifyClientInfo Method

version: 7.2.1.27

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: 7.2.1.27 (7.2.1.27)

Syntax

C++

Copy

ReturnCode ModifyClientInfo(
	SessionPropertiesPROPERTY sessionProperty,
	Object value,
	int flags,
	Object correlationKey
)

Function ModifyClientInfo ( 
	sessionProperty As SessionPropertiesPROPERTY,
	value As Object,
	flags As Integer,
	correlationKey As Object
) As ReturnCode

ReturnCode ModifyClientInfo(
	SessionPropertiesPROPERTY sessionProperty, 
	Object^ value, 
	int flags, 
	Object^ correlationKey
)

Parameters

sessionProperty: Type: SolaceSystems.Solclient.MessagingSessionPropertiesPROPERTY
The property to modify.
value: Type: SystemObject
The new value for the property.
flags: Type: SystemInt32
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: Type: SystemObject
When specified (i.e. non null reference passed in), this correlationKey is returned in CorrelationKey - It is ignored if WaitForConfirm is specified.

Return Value

Type: ReturnCode
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.

Exceptions

Exception	Condition
OperationErrorException	Thrown when the operation fails. Possible error subcodes include: ClientNameAlreadyInUse ClientNameInvalid
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.

Reference

ISession Interface

SolaceSystems.Solclient.Messaging Namespace

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to use and copy the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

UNLESS STATED ELSEWHERE BETWEEN YOU AND SOLACE SYSTEMS, INC., THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Send comments on this topic to [email protected]

previous page start next page