proxmox-mirrors/mirror_frr
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_frr synced 2025-08-12 11:18:59 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

bgpd: Add some documentation for bgp_vty_find_and_parse_afi_safi_vrf

Browse Source 
The use of this function was causing some confusion.  As
such let's add some documentation.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
This commit is contained in:
Donald Sharp 2017-01-25 09:37:13 -05:00
parent 08435c2b24
commit 7eeee51e02
1 changed files with 30 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
bgpd/bgp_vty.c
View File

@ -197,6 +197,36 @@ argv_find_and_parse_safi (struct cmd_token **argv, int argc, int *index, safi_t
return ret; return ret;
} }
/*
* bgp_vty_find_and_parse_afi_safi_vrf
*
* For a given 'show ...' command, correctly parse the afi/safi/vrf out from it
* This function *assumes* that the calling function pre-sets the afi/safi/vrf
* to appropriate values for the calling function. This is to allow the
* calling function to make decisions appropriate for the show command
* that is being parsed.
*
* The show commands are generally of the form:
* "show [ip] bgp [<view|vrf> WORD] [<ipv4|ipv6> [<unicast|multicast|vpn|encap>]] ..."
*
* Since we use argv_find if the show command in particular doesn't have:
* [ip]
* [<view|vrf> WORD]
* [<ipv4|ipv6> [<unicast|multicast|vpn|encap>]]
* The command parsing should still be ok.
*
* vty -> The vty for the command so we can output some useful data in
* the event of a parse error in the vrf.
* argv -> The command tokens
* argc -> How many command tokens we have
* idx -> The current place in the command, generally should be 0 for this function
* afi -> The parsed afi if it was included in the show command, returned here
* safi -> The parsed safi if it was included in the show command, returned here
* vrf -> The parsed vrf id if it was included in the show command, returned here
*
* The function returns the correct location in the parse tree for the
* last token found.
*/
int int
bgp_vty_find_and_parse_afi_safi_vrf (struct vty *vty, struct cmd_token **argv, int argc, int idx, bgp_vty_find_and_parse_afi_safi_vrf (struct vty *vty, struct cmd_token **argv, int argc, int idx,
afi_t *afi, safi_t *safi, vrf_id_t *vrf) afi_t *afi, safi_t *safi, vrf_id_t *vrf)