TipcLbModeToStr

Name

TipcLbModeToStr — convert a message load balancing mode to a string

Synopsis

T_BOOL TipcLbModeToStr(lb_mode, lb_mode_str_return) 
T_IPC_LB_MODE lb_mode; 
T_STR *lb_mode_str_return; 

Arguments

lb_mode — load balancing mode to convert

lb_mode_str_return — storage for string

Return Values

TRUE if the load balancing mode was successfully converted to a string, FALSE otherwise.

Diagnostics

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

Description

TipcLbModeToStr converts a message load balancing mode (such as T_IPC_LB_SORTED) to a lower-case string (such as sorted).

Caution

If TipcLbModeToStr returns FALSE, it does not store a value in lb_mode_str_return. The value stored in lb_mode_str_return points directly into an internal data structure and should not be modified.

See Also

TipcStrToLbMode

Examples

This example prints the load balancing mode of a message:

T_IPC_LB_MODE lb_mode; 
T_STR lb_mode_str; 
 
if (!TipcMsgGetLbMode(msg, &lb_mode)) { 
  return;  /* error */ 
} 
 
if (!TipcLbModeToStr(lb_mode, &lb_mode_str)) { 
  return;  /* error */ 
}  
 
TutOut("Message has load balancing mode %s (%d).\n", 
       lb_mode_str, lb_mode);