zebra: Add some documentation on when zserv_open should be used

Signed-off-by: Donald Sharp <sharpd@nvidia.com>
This commit is contained in:
Donald Sharp 2025-01-15 13:03:52 -05:00
parent 283cc51178
commit 4b96752737
2 changed files with 7 additions and 0 deletions

View File

@ -937,6 +937,10 @@ void zserv_close(void)
/*
* Open zebra's ZAPI listener socket. This is done early during startup,
* before zebra is ready to listen and accept client connections.
*
* This function should only ever be called from the startup pthread
* from main.c. If it is called multiple times it will cause problems
* because it causes the zsock global variable to be setup.
*/
void zserv_open(const char *path)
{

View File

@ -262,6 +262,9 @@ extern void zserv_close(void);
*
* path
* where to place the Unix domain socket
*
* This function *should* only ever be called from
* main() and only every from 1 pthread.
*/
extern void zserv_open(const char *path);