ISession.Send Method (IMessage)

Solclient

previous page next page

Solclient

ISessionSend Method (IMessage)

version: 7.2.1.27

Sends a message over the session.

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 Send(
	IMessage message
)

Function Send ( 
	message As IMessage
) As ReturnCode

ReturnCode Send(
	IMessage^ message
)

Parameters

message: Type: SolaceSystems.Solclient.MessagingIMessage
an IMessage instance

Return Value

Type: ReturnCode
SOLCLIENT_OK if successful. Or SOLCLIENT_WOULD_BLOCK if the message cannot be accepted by the API immediately. The API signals its readiness to accept messages through a CanSend event type.

Note: returning SOLCLIENT_OK means that the message has been successfully copied to the underlying transport which does not guarantee successful delivery to the Solace appliance. In the case of persistent or non-persistent messages, the application will receive a subsequent Acknowledgement event for all messages (persistent and non-persistent) successfully delivered to the Solace appliance. For guaranteed(persistent or non-persistent) messages which cannot be accepted by the Solace appliance (quota, permission or other delivery problems), a RejectedMessageError event will be generated.

Special Buffering of Guaranteed Messages

Guaranteed messages (MessageDeliveryMode.Persistent or MessageDeliveryMode.NonPersistent) are assured by the protocol between the client and the Solace message-router. To make developers' task easier, guaranteed messages are queued for delivery in many instances:

While transport (TCP) flow controlled.
While message-router flow controlled.
While sessions are connecting or reconnecting.
While sessions are disconnected or down.

The SDK will buffer up to a publishers window size (ADPublishWindowSize ) of guaranteed messages before solClient_session_sendMsg() will either block (when SendBlocking is enabled) or return SOLCLIENT_WOULD_BLOCK (on active sessions)

For the most part this is desired behavior. Transient sessions failures do not require special handling in applications. When ReconnectRetries is non-zero, the underlying transport will automatically reconnect and the publishing application does not need to concern itself with special handling for the transient reconnecting state.

Exceptions

Exception	Condition
OperationErrorException	Thrown when the Send operation fails. Possible sub-codes: InsufficientSpace TopicTooLarge TopicMissing UserDataTooLarge QueueNameTooLarge QueueNameInvalidMode QueueNameTopicConflict MaxTotalMessageSizeExceeded DTOInvalid TooManyClients InvalidSessionOperation Timeout CommunicationError
ObjectDisposedException	Thrown when the session is already disposed (terminal state).
FatalErrorException	Thrown when an unrecoverable error occurs.
ArgumentNullException	Thrown if message is null.

Reference

ISession Interface

Send Overload

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