proxmox-mirrors/mirror_frr
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_frr synced 2025-06-06 13:10:22 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #16150 from LabNConsulting/chopps/native-message-comments

Browse Source 
lib: comments about public vs private message apis
This commit is contained in:
Donatas Abraitis 2024-06-04 11:49:42 +03:00 committed by GitHub
commit a24c8050e1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 18 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
lib/mgmt_msg_native.h
View File

@ -4,6 +4,15 @@
* *
* Copyright (c) 2023, LabN Consulting, L.L.C. * 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_ #ifndef _FRR_MGMT_MSG_NATIVE_H_
@ -158,15 +167,15 @@ DECLARE_MTYPE(MSG_NATIVE_RPC_REPLY);
/* /*
* Native message codes * Native message codes
*/ */
#define MGMT_MSG_CODE_ERROR 0 #define MGMT_MSG_CODE_ERROR 0 /* Public API */
#define MGMT_MSG_CODE_GET_TREE 1 #define MGMT_MSG_CODE_GET_TREE 1 /* BE only, non-public API */
#define MGMT_MSG_CODE_TREE_DATA 2 #define MGMT_MSG_CODE_TREE_DATA 2 /* Public API */
#define MGMT_MSG_CODE_GET_DATA 3 #define MGMT_MSG_CODE_GET_DATA 3 /* Public API */
#define MGMT_MSG_CODE_NOTIFY 4 #define MGMT_MSG_CODE_NOTIFY 4 /* Public API */
#define MGMT_MSG_CODE_EDIT 5 #define MGMT_MSG_CODE_EDIT 5 /* Public API */
#define MGMT_MSG_CODE_EDIT_REPLY 6 #define MGMT_MSG_CODE_EDIT_REPLY 6 /* Public API */
#define MGMT_MSG_CODE_RPC 7 #define MGMT_MSG_CODE_RPC 7 /* Public API */
#define MGMT_MSG_CODE_RPC_REPLY 8 #define MGMT_MSG_CODE_RPC_REPLY 8 /* Public API */
/* /*
* Datastores * Datastores