diff options
| author | Christian Hopps <chopps@labn.net> | 2024-06-04 00:51:33 -0400 |
|---|---|---|
| committer | Christian Hopps <chopps@labn.net> | 2024-06-04 00:51:33 -0400 |
| commit | 41c236120ff98ce9173c63a3402f80590d608290 (patch) | |
| tree | a85b9c54d21f40f5d86cb0d8273dc0404ad5b803 /lib/mgmt_msg_native.h | |
| parent | 41eb06801c47d957c24d6a14e116c958454d433a (diff) | |
lib: comments about public vs private message apis
Signed-off-by: Christian Hopps <chopps@labn.net>
Diffstat (limited to 'lib/mgmt_msg_native.h')
| -rw-r--r-- | lib/mgmt_msg_native.h | 27 |
1 files changed, 18 insertions, 9 deletions
diff --git a/lib/mgmt_msg_native.h b/lib/mgmt_msg_native.h index cf528a6356..21f702cc61 100644 --- a/lib/mgmt_msg_native.h +++ b/lib/mgmt_msg_native.h @@ -4,6 +4,15 @@ * * Copyright (c) 2023, LabN Consulting, L.L.C. * + * Public APIs: + * + * The message type codes and corresponding message data definitions for + * front-end client messages represent a public API, as such any changes should + * only be made according to backward compatible principles (basically never, + * just use a new message type). Back-end clients being always compiled with FRR + * can be updated (although one should take care in modifying BE messages as it + * could impact private back-end client implementations which will then need to + * be updated by their owners). */ #ifndef _FRR_MGMT_MSG_NATIVE_H_ @@ -158,15 +167,15 @@ DECLARE_MTYPE(MSG_NATIVE_RPC_REPLY); /* * Native message codes */ -#define MGMT_MSG_CODE_ERROR 0 -#define MGMT_MSG_CODE_GET_TREE 1 -#define MGMT_MSG_CODE_TREE_DATA 2 -#define MGMT_MSG_CODE_GET_DATA 3 -#define MGMT_MSG_CODE_NOTIFY 4 -#define MGMT_MSG_CODE_EDIT 5 -#define MGMT_MSG_CODE_EDIT_REPLY 6 -#define MGMT_MSG_CODE_RPC 7 -#define MGMT_MSG_CODE_RPC_REPLY 8 +#define MGMT_MSG_CODE_ERROR 0 /* Public API */ +#define MGMT_MSG_CODE_GET_TREE 1 /* BE only, non-public API */ +#define MGMT_MSG_CODE_TREE_DATA 2 /* Public API */ +#define MGMT_MSG_CODE_GET_DATA 3 /* Public API */ +#define MGMT_MSG_CODE_NOTIFY 4 /* Public API */ +#define MGMT_MSG_CODE_EDIT 5 /* Public API */ +#define MGMT_MSG_CODE_EDIT_REPLY 6 /* Public API */ +#define MGMT_MSG_CODE_RPC 7 /* Public API */ +#define MGMT_MSG_CODE_RPC_REPLY 8 /* Public API */ /* * Datastores |