TipcSrvMsgInsert

Name

TipcSrvMsgInsert — insert message into queue of the connection to RTserver

Synopsis

T_BOOL TipcSrvMsgInsert(msg, pos) 
T_IPC_MSG msg; 
T_INT4 pos;

Arguments

msg — message to insert

pos — position to insert message

Return Values

TRUE if the message was successfully inserted into the queue in the connection to RTserver, FALSE otherwise.

Diagnostics

If TipcSrvMsgInsert 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_VAL_INVALID — pos was negative or larger than the number of messages in the queue

T_ERR_SRV_NOT_CONNECTED — a connection to RTserver could not be created

any error number from TipcConnMsgInsert

Description

TipcSrvMsgInsert inserts a message into the message queue of the connection to RTserver by calling TipcConnMsgInsert. A connection has a priority queue of incoming messages. See TipcConnMsgInsert for more information on inserting a message into a connection message queue.

TipcSrvMsgInsert may attempt to automatically create a connection to RTserver. If RTclient has a warm connection to RTserver, TipcSrvMsgInsert inserts the message into the message queue of the warm connection. See TipcSrvCreate on automatic creation of connections and warm connections to RTserver.

Caution

Do not call TipcMsgDestroy to destroy the message passed to TipcSrvMsgInsert, as TipcSrvMsgInsert takes responsibility for destroying the message.

Examples

This example constructs a message and inserts it onto the front of the message queue of the connection to RTserver:

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, "temperature", 98.6)) { 
  return;  /* error */ 
}  
 
if (!TipcSrvMsgInsert(msg, 0)) { 
  return;  /* error */ 
}  
/* At this point, msg "belongs" to the connection to RTserver, */ 
/* and should not be destroyed by the caller */