bbfdm/docs/guide/migrate_deprecated_api.md
2023-10-31 13:26:17 +00:00

8.4 KiB

Migration of deprecated APIs and user defined datatypes

To support new feature sometimes old APIs provided by libbbfdm-api library needs to be updated, this guide provides a better context to the migration.

Following table has deprecated and new APIs, datatypes:

Type Deprecated API New API Comment
function dm_validate_string(char *value, int min_length, int max_length, char *enumeration[], char *pattern[]) int bbfdm_validate_string(struct dmctx *ctx, char *value, int min_length, int max_length, char *enumeration[], char *pattern[]) Replace to support fault_msg in case of errors
function bbf_validate_string(char *value, int min_length, int max_length, char *enumeration[], char *pattern[]) int bbfdm_validate_string(struct dmctx *ctx, char *value, int min_length, int max_length, char *enumeration[], char *pattern[]) Replace to support fault_msg in case of errors
function bbf_validate_boolean(char *value) int bbfdm_validate_boolean(struct dmctx *ctx, char *value) Replace to support fault_msg in case of errors
function bbf_validate_unsignedInt(char *value, struct range_args r_args[], int r_args_size) int bbfdm_validate_unsignedInt(struct dmctx *ctx, char *value, struct range_args r_args[], int r_args_size) Replace to support fault_msg in case of errors
function bbf_validate_int(char *value, struct range_args r_args[], int r_args_size) int bbfdm_validate_int(struct dmctx *ctx, char *value, struct range_args r_args[], int r_args_size) Replace to support fault_msg in case of errors
function bbf_validate_unsignedLong(char *value, struct range_args r_args[], int r_args_size) int bbfdm_validate_unsignedLong(struct dmctx *ctx, char *value, struct range_args r_args[], int r_args_size) Replace to support fault_msg in case of errors
function bbf_validate_long(char *value, struct range_args r_args[], int r_args_size) int bbfdm_validate_long(struct dmctx *ctx, char *value, struct range_args r_args[], int r_args_size) Replace to support fault_msg in case of errors
function bbf_validate_dateTime(char *value) int bbfdm_validate_dateTime(struct dmctx *ctx, char *value) Replace to support fault_msg in case of errors
function bbf_validate_hexBinary(char *value, struct range_args r_args[], int r_args_size) int bbfdm_validate_hexBinary(struct dmctx *ctx, char *value, struct range_args r_args[], int r_args_size) Replace to support fault_msg in case of errors
function bbf_validate_string_list(char *value, int min_item, int max_item, int max_size, int min, int max, char *enumeration[], char *pattern[]) int bbfdm_validate_string_list(struct dmctx *ctx, char *value, int min_item, int max_item, int max_size, int min, int max, char *enumeration[], char *pattern[]) Replace to support fault_msg in case of errors
function bbf_validate_unsignedInt_list(char *value, int min_item, int max_item, int max_size, struct range_args r_args[], int r_args_size) int bbfdm_validate_unsignedInt_list(struct dmctx *ctx, char *value, int min_item, int max_item, int max_size, struct range_args r_args[], int r_args_size) Replace to support fault_msg in case of errors
function bbf_validate_int_list(char *value, int min_item, int max_item, int max_size, struct range_args r_args[], int r_args_size) int bbfdm_validate_int_list(struct dmctx *ctx, char *value, int min_item, int max_item, int max_size, struct range_args r_args[], int r_args_size) Replace to support fault_msg in case of errors
function bbf_validate_unsignedLong_list(char *value, int min_item, int max_item, int max_size, struct range_args r_args[], int r_args_size) int bbfdm_validate_unsignedLong_list(struct dmctx *ctx, char *value, int min_item, int max_item, int max_size, struct range_args r_args[], int r_args_size) Replace to support fault_msg in case of errors
function bbf_validate_long_list(char *value, int min_item, int max_item, int max_size, struct range_args r_args[], int r_args_size) int bbfdm_validate_long_list(struct dmctx *ctx, char *value, int min_item, int max_item, int max_size, struct range_args r_args[], int r_args_size) Replace to support fault_msg in case of errors
function bbf_validate_hexBinary_list(char *value, int min_item, int max_item, int max_size, struct range_args r_args[], int r_args_size) int bbfdm_validate_hexBinary_list(struct dmctx *ctx, char *value, int min_item, int max_item, int max_size, struct range_args r_args[], int r_args_size) Replace to support fault_msg in case of errors
function dm_validate_boolean(char *value) int bbfdm_validate_boolean(struct dmctx *ctx, char *value) Replace to support fault_msg in case of errors
function dm_validate_unsignedInt(char *value, struct range_args r_args[], int r_args_size) int bbfdm_validate_unsignedInt(struct dmctx *ctx, char *value, struct range_args r_args[], int r_args_size) Replace to support fault_msg in case of errors
function dm_validate_int(char *value, struct range_args r_args[], int r_args_size) int bbfdm_validate_int(struct dmctx *ctx, char *value, struct range_args r_args[], int r_args_size) Replace to support fault_msg in case of errors
function dm_validate_unsignedLong(char *value, struct range_args r_args[], int r_args_size) int bbfdm_validate_unsignedLong(struct dmctx *ctx, char *value, struct range_args r_args[], int r_args_size) Replace to support fault_msg in case of errors
function dm_validate_long(char *value, struct range_args r_args[], int r_args_size) int bbfdm_validate_long(struct dmctx *ctx, char *value, struct range_args r_args[], int r_args_size) Replace to support fault_msg in case of errors
function dm_validate_dateTime(char *value) int bbfdm_validate_dateTime(struct dmctx *ctx, char *value) Replace to support fault_msg in case of errors
function dm_validate_hexBinary(char *value, struct range_args r_args[], int r_args_size) int bbfdm_validate_hexBinary(struct dmctx *ctx, char *value, struct range_args r_args[], int r_args_size) Replace to support fault_msg in case of errors
function dm_validate_string_list(char *value, int min_item, int max_item, int max_size, int min, int max, char *enumeration[], char *pattern[]) int bbfdm_validate_string_list(struct dmctx *ctx, char *value, int min_item, int max_item, int max_size, int min, int max, char *enumeration[], char *pattern[]) Replace to support fault_msg in case of errors
function dm_validate_unsignedInt_list(char *value, int min_item, int max_item, int max_size, struct range_args r_args[], int r_args_size) int bbfdm_validate_unsignedInt_list(struct dmctx *ctx, char *value, int min_item, int max_item, int max_size, struct range_args r_args[], int r_args_size) Replace to support fault_msg in case of errors
function dm_validate_int_list(char *value, int min_item, int max_item, int max_size, struct range_args r_args[], int r_args_size) int bbfdm_validate_int_list(struct dmctx *ctx, char *value, int min_item, int max_item, int max_size, struct range_args r_args[], int r_args_size) Replace to support fault_msg in case of errors
function dm_validate_unsignedLong_list(char *value, int min_item, int max_item, int max_size, struct range_args r_args[], int r_args_size) int bbfdm_validate_unsignedLong_list(struct dmctx *ctx, char *value, int min_item, int max_item, int max_size, struct range_args r_args[], int r_args_size) Replace to support fault_msg in case of errors
function dm_validate_long_list(char *value, int min_item, int max_item, int max_size, struct range_args r_args[], int r_args_size) int bbfdm_validate_long_list(struct dmctx *ctx, char *value, int min_item, int max_item, int max_size, struct range_args r_args[], int r_args_size) Replace to support fault_msg in case of errors
function dm_validate_hexBinary_list(char *value, int min_item, int max_item, int max_size, struct range_args r_args[], int r_args_size) int bbfdm_validate_hexBinary_list(struct dmctx *ctx, char *value, int min_item, int max_item, int max_size, struct range_args r_args[], int r_args_size) Replace to support fault_msg in case of errors
enum CMD_SUCCESS Removed, no more required
enum CMD_INVALID_ARGUMENTS Removed, no more required
enum CMD_FAIL Removed, no more required
enum CMD_NOT_FOUND Removed, no more required
enum __STATUS_MAX Removed, no more required