TipcMsgSetDeliveryMode

Name

TipcMsgSetDeliveryMode — set the delivery mode of a message

Synopsis

T_BOOL TipcMsgSetDeliveryMode(msg, delivery_mode) 
T_IPC_MSG msg; 
T_IPC_DELIVERY_MODE delivery_mode;

Arguments

msg — message to set delivery mode for

delivery_mode — message delivery mode (T_IPC_DELIVERY_BEST_EFFORT, T_IPC_DELIVERY_ORDERED, T_IPC_DELIVERY_SOME, or T_IPC_DELIVERY_ALL)

Return Values

TRUE if the delivery mode was successfully set for the message, FALSE otherwise.

Diagnostics

If TipcMsgSetDeliveryMode fails, it returns FALSE and sets the global SmartSockets error number to one of:

T_ERR_NULL_PTR — msg was null

T_ERR_MSG_INVALID — msg was not a valid message

T_ERR_READ_ONLY — the message was marked read-only. This happens if the message is a field in another message.

T_ERR_VAL_INVALID — delivery_mode was not a valid T_IPC_DELIVERY_MODE

Description

TipcMsgSetDeliveryMode sets the delivery mode of a message. The delivery mode of a message controls what level of guarantee is used when the message is sent through a connection with TipcConnMsgSend. Valid delivery mode values are:

T_IPC_DELIVERY_BEST_EFFORT

T_IPC_DELIVERY_ORDERED

T_IPC_DELIVERY_SOME

T_IPC_DELIVERY_ALL

TipcMsgSetDeliveryMode overwrites the default value of the delivery mode property set by TipcMtSetDeliveryMode. See TipcMsgGetDeliveryMode for more information on message delivery modes.

Caution

If you are sending messages to JMS clients, set the delivery mode to T_IPC_DELIVERY_ORDERED.

Examples

This example sets the delivery mode of a message:

if (!TipcMsgSetDeliveryMode(msg, T_IPC_DELIVERY_ALL)) { 
  return;  /* error */ 
}