IFlow.ReceiveMsg Method

Solclient

previous page next page

Solclient

IFlowReceiveMsg Method

version: 7.2.1.27

Receives a message from a specified transacted Flow. It waits until a timeout or a message is received. No wait if timeout is zero. Applications must later call .Dispose() on the received message to release it.

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

IMessage ReceiveMsg(
	int timeout
)

Function ReceiveMsg ( 
	timeout As Integer
) As IMessage

IMessage^ ReceiveMsg(
	int timeout
)

Parameters

timeout: Type: SystemInt32
Timeout in milliseconds, 0 means no wait.

Return Value

Type: IMessage
The received message is returned as a IMessage A null mussage is returned under these circumstances: The queue is empty and a timeout occured The queue is empty and the timeout was zero The flow is not a transacted flow

Exceptions

Exception	Condition
OperationErrorException	An OperationErrorException is thrown when this method fails. The exception will contain one of these return codes: SOLCLIENT_FAIL - FlowUnbound - The flow is unbound and there are no messages waiting within the API to be delivered. CommitRollbackAlreadyInProgress - A commit or rollback is in progress. InvalidFlowOperation - The flow is not associated with a transacted session. SOLCLIENT_NOT_READY - SessionNotEstablished - The session hasn't been established yet NoTransactionStarted - No transaction has been started yet

Exception

Condition

OperationErrorException

An OperationErrorException is thrown when this method fails. The exception will contain one of these return codes:

SOLCLIENT_FAIL -
- FlowUnbound - The flow is unbound and there are no messages waiting within the API to be delivered.
- CommitRollbackAlreadyInProgress - A commit or rollback is in progress.
- InvalidFlowOperation - The flow is not associated with a transacted session.
SOLCLIENT_NOT_READY -
- SessionNotEstablished - The session hasn't been established yet
- NoTransactionStarted - No transaction has been started yet

Reference

IFlow 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