Message Type Functions (TipcMt*)

The TipcMt* functions are used to work with message types, which are templates for messages.

TipcMtCreate — create a new message type

T_IPC_MT TipcMtCreate(name, num, grammar) 
T_STR name; 
T_INT4 num; 
T_STR grammar;

TipcMtDestroy — destroy a message type

T_BOOL TipcMtDestroy(mt) 
T_IPC_MT mt;

TipcMtLogAddMt — add a message type to a message file logging type

T_BOOL TipcMtLogAddMt(log_type, mt) 
T_IPC_SRV_LOG_TYPE log_type; 
T_IPC_MT mt;

TipcMtLogRemoveMt — remove a message type from a message file logging type

T_BOOL TipcMtLogRemoveMt(log_type, mt) 
T_IPC_SRV_LOG_TYPE log_type; 
T_IPC_MT mt;

TipcMtLookup — look up a message type by name

T_IPC_MT TipcMtLookup(name) 
T_STR name;

TipcMtLookupByNum — look up a message type by number

T_IPC_MT TipcMtLookupByNum(num) 
T_INT4 num;

TipcMtPrint— print all information about a message type in a portable, reproducible format

T_BOOL TipcMtPrint(mt, func) 
T_IPC_MT mt; 
T_OUT_FUNC func;

TipcMtTraverse — traverse all message types

T_PTR TipcMtTraverse(func, arg) 
T_IPC_MT_TRAV_FUNC func; 
T_PTR arg;

The TipcMtGet* functions are used to retrieve information about a message type.

TipcMtGetCompression — get the compression setting of a message type

T_BOOL TipcMtGetCompressoin(mt, compress_return) 
T_IPC_MT mt; 
T_BOOL *compress_return;

TipcMtGetDeliveryMode — determine the delivery mode of a message type

T_BOOL TipcMtGetDeliveryMode(mt, delivery_mode_return) 
T_IPC_MT mt; 
T_IPC_DELIVERY_MODE *delivery_mode_return;

TipcMtGetDeliveryTimeout — determine the delivery timeout property of a message type

T_BOOL TipcMtGetDeliveryTimeout(mt, delivery_timeout_return) 
T_IPC_MT mt; 
T_REAL8 *delivery_timeout_return;

TipcMtGetGrammar — determine the grammar of a message type

T_BOOL TipcMtGetGrammar(mt, grammar_return) 
T_IPC_MT mt; 
T_STR *grammar_return;

TipcMtGetHeaderStrEncode — determine the header string encode property of a message type

T_BOOL TipcMtGetHeaderStrEncode(mt, header_str_encode_return) 
T_IPC_MT mt; 
T_BOOL *header_str_encode_return;

TipcMtGetLbMode — determine the load balancing mode of a message type

T_BOOL TipcMtGetLbMode(mt, lb_mode_return) 
T_IPC_MT mt; 
T_IPC_LB_MODE *lb_mode_return;

TipcMtGetName — determine the name of a message type

T_BOOL TipcMtGetName(mt, name_return) 
T_IPC_MT mt; 
T_STR *name_return;

TipcMtGetNum — determine the number of a message type

T_BOOL TipcMtGetNum(mt, num_return) 
T_IPC_MT mt; 
T_INT4 *num_return;

TipcMtGetPriority — determine the priority of a message type

T_BOOL TipcMtGetPriority(mt, priority_return) 
T_IPC_MT mt; 
T_INT2 *priority_return;

TipcMtGetUserProp — determine the user-defined property of a message type

T_BOOL TipcMtGetUserProp(mt, user_prop_return) 
T_IPC_MT mt; 
T_INT4 *user_prop_return;

The TipcMtSet* functions are used to set the properties of a message type.

TipcMtSetCompression — set the compression setting of a message type

T_BOOL TipcMtSetCompression(mt, compress)  
T_IPC_MT mt;  
T_BOOL compress;

TipcMtSetDeliveryMode — set the delivery mode of a message type

T_BOOL TipcMtSetDeliveryMode(mt, delivery_mode) 
T_IPC_MT mt; 
T_IPC_DELIVERY_MODE delivery_mode;

TipcMtSetDeliveryTimeout — set the delivery timeout property of a message type

T_BOOL TipcMtSetDeliveryMode(mt, delivery_timeout) 
T_IPC_MT mt; 
T_REAL8 delivery_timeout;

TipcMtSetHeaderStrEncode — set the header string encode property of a message type

T_BOOL TipcMtSetHeaderStrEncode(mt, header_str_encode) 
T_IPC_MT mt; 
T_BOOL header_str_encode;

TipcMtSetLbMode — set the load balancing mode of a message type

T_BOOL TipcMtSetDeliveryMode(mt, lb_mode) 
T_IPC_MT mt; 
T_IPC_LB_MODE lb_mode;

TipcMtSetPriority — set the priority of a message type

T_BOOL TipcMtSetPriority(mt, priority) 
T_IPC_MT mt; 
T_INT2 priority;

TipcMtSetPriorityUnknown — set the priority of a message type to unknown

T_BOOL TipcMtSetPriorityUnknown(mt) 
T_IPC_MT mt;

TipcMtSetUserProp — set the user-defined property of a message type

T_BOOL TipcMtSetUserProp(mt, user_prop) 
T_IPC_MT mt; 
T_INT4 user_prop;