Utility Operations

Enumerations
enum	ucc_config_print_flags_t {   UCC_CONFIG_PRINT_CONFIG = UCC_BIT(0) ,   UCC_CONFIG_PRINT_HEADER = UCC_BIT(1) ,   UCC_CONFIG_PRINT_DOC = UCC_BIT(2) ,   UCC_CONFIG_PRINT_HIDDEN = UCC_BIT(3) }
	Print configurations. More...
enum	ucc_status_t {   UCC_OK = 0 ,   UCC_INPROGRESS = 1 ,   UCC_OPERATION_INITIALIZED = 2 ,   UCC_ERR_NOT_SUPPORTED = -1 ,   UCC_ERR_NOT_IMPLEMENTED = -2 ,   UCC_ERR_INVALID_PARAM = -3 ,   UCC_ERR_NO_MEMORY = -4 ,   UCC_ERR_NO_RESOURCE = -5 ,   UCC_ERR_NO_MESSAGE = -6 ,   UCC_ERR_NOT_FOUND = -7 ,   UCC_ERR_TIMED_OUT = -8 ,   UCC_ERR_LAST = -100 }
	Status codes for the UCC operations. More...

Functions
const char *	ucc_status_string (ucc_status_t status)
	Routine to convert status code to string. More...

Detailed Description

Helper functions to be used across the library

Enumeration Type Documentation

ucc_config_print_flags_t

enum ucc_config_print_flags_t

Enumerator
UCC_CONFIG_PRINT_CONFIG
UCC_CONFIG_PRINT_HEADER
UCC_CONFIG_PRINT_DOC
UCC_CONFIG_PRINT_HIDDEN

ucc_status_t

enum ucc_status_t

Enumerator
UCC_OK
UCC_INPROGRESS	Operation is posted and is in progress
UCC_OPERATION_INITIALIZED	Operation initialized but not posted
UCC_ERR_NOT_SUPPORTED
UCC_ERR_NOT_IMPLEMENTED
UCC_ERR_INVALID_PARAM
UCC_ERR_NO_MEMORY
UCC_ERR_NO_RESOURCE
UCC_ERR_NO_MESSAGE	General purpose return code without specific error
UCC_ERR_NOT_FOUND
UCC_ERR_TIMED_OUT
UCC_ERR_LAST

Function Documentation

ucc_status_string()

const char * ucc_status_string

(

ucc_status_t

status

)