TipcSrvMsgSend

T_BOOL TipcSrvMsgSend(msg, check_server_msg_send) 
T_IPC_MSG msg; 
T_BOOL check_server_msg_send;

Arguments

check_server_msg_send — whether or not to check the option Server_Msg_Send first

Return Values

Diagnostics

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

T_ERR_NULL_PTR — msg was null or the destination of msg was null

T_ERR_MSG_INVALID — msg was not a valid message

T_ERR_VAL_INVALID — check_server_msg_send was not TRUE or FALSE, or destination of msg is not a valid subject

T_ERR_SRV_NOT_CONNECTED — a connection to RTserver could not be created

any error number from TipcConnMsgSend

Description

TipcSrvMsgSend sends a message for publish-subscribe through the connection to RTserver by calling TipcConnMsgSend. If check_server_msg_send is TRUE and the option Server_Msg_Send is FALSE, then TipcSrvMsgSend does not send the message, but returns TRUE immediately. Otherwise TipcSrvMsgSend first temporarily sets the sender of the message (using the value of the option Unique_Subject), then temporarily prepends the value of the option Default_Subject_Prefix to the message sender and destination if they do not start with slash (/), and then calls TipcConnMsgSend. See TipcConnMsgSend for more information on sending messages through connections.

For normal usage, check_server_msg_send should always be TRUE. This allows the user to globally turn off all normal outgoing messages by setting the option Server_Msg_Send to FALSE. This is useful for running two RTclients (such as two RTie processes), the primary one with Server_Msg_Send set to TRUE and the backup one with Server_Msg_Send set to FALSE.

If RTclient has a warm connection to RTserver, TipcSrvMsgSend buffers the message as if the RTclient were still connected to RTserver. See TipcSrvCreate on warm connections to RTserver.

Caution

See Also

Examples

This example creates a NUMERIC_DATA message, appends fields, sets the destination subject, sends the message with TipcSrvMsgSend, sets the destination to a second subject, and sends the message again:

T_IPC_MT mt; 
T_IPC_MSG msg; 
 
mt = TipcMtLookupByNum(T_MT_NUMERIC_DATA); 
if (mt == NULL) { 
  return;  /* error */ 
}  
 
msg = TipcMsgCreate(mt); 
if (msg == NULL) { 
  return;  /* error */ 
}  
 
if (!TipcMsgAppendStrReal8(msg, "speed_limit", 65.0)) { 
  return;  /* error */ 
}  
 
if (!TipcMsgSetDest(msg, "/system/admin")) { 
  return;  /* error */ 
}  
 
/* send the message */ 
if (!TipcSrvMsgSend(msg, TRUE)) { 
    return;  /* error */ 
}  
 
if (!TipcMsgSetDest(msg, "/system/test")) { 
  return;  /* error */ 
}  
 
/* send the message again, but to a different subject */ 
if (!TipcSrvMsgSend(msg, TRUE)) { 
    return;  /* error */ 
}