ITransactedSession.Commit Method

Solclient

ITransactedSessionCommit Method

version: 7.2.1.27

Commits the active transaction on the given transacted session. This method blocks the calling thread until a response is received or the operation fails.

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 Commit()

Function Commit As ReturnCode

ReturnCode Commit()

Return Value

Type: ReturnCode
SOLCLIENT_OK

Exceptions

Exception	Condition
OperationErrorException	Thrown when the operation fails. Typically this is thrown when the commit request has failed and must be rolled back. When the ReturnCode is set to SOLCLIENT_ROLLBACK, further reason for the rollback is available in the subcode: InvalidTransactedSessionID InvalidTransactionID NoTransactionStarted MessagePublishFailure TransactionFailure QueueShutdown TEShutdown SpoolOverQuota QueueNotFound InvalidConnectionOwner EndpointModified CommitRollbackAlreadyInProgress If the ReturnCode is SOLCLIENT_FAIL The status of the outstanding commit request cannot be determined. The commit may have succeeded on the message-router before the response was lost. Or the commit request may have failed (roll back). Applications that treat this failure as a rollback must allow for duplicate transactions. Possible subcodes when the ReturnCode is SOLCLIENT_FAIL are: CommitStatusUnknown Timeout
ObjectDisposedException	Thrown when the session is already disposed (terminal state).
FatalErrorException	Thrown when an unrecoverable error occurs.

Exception

Condition

OperationErrorException

Thrown when the operation fails. Typically this is thrown when the commit request has failed and must be rolled back. When the ReturnCode is set to SOLCLIENT_ROLLBACK, further reason for the rollback is available in the subcode:

If the ReturnCode is SOLCLIENT_FAIL The status of the outstanding commit request cannot be determined. The commit may have succeeded on the message-router before the response was lost. Or the commit request may have failed (roll back). Applications that treat this failure as a rollback must allow for duplicate transactions. Possible subcodes when the ReturnCode is SOLCLIENT_FAIL are:

ObjectDisposedException

Thrown when the session is already disposed (terminal state).

FatalErrorException

Thrown when an unrecoverable error occurs.

Reference

ITransactedSession 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