X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=doc%2Flibrouteros.pod;h=9e083a7eebd413e1918b74912a9be1c6b42274aa;hb=20ae1607659c975a777e5de324d5d4e94d02f25c;hp=d1ea98b4b049e1e0a368feb34c72b75abddf13ad;hpb=71c3e87fb2d0fdfff80f0cead3f5dc8643a1f189;p=routeros-api.git diff --git a/doc/librouteros.pod b/doc/librouteros.pod index d1ea98b..9e083a7 100644 --- a/doc/librouteros.pod +++ b/doc/librouteros.pod @@ -163,7 +163,25 @@ when the callback returns. =head2 High level interface functions for "registration-table" -B: Describe the registration-table interface. +This high level interface makes it easy to access the "registration table", +which holds active wireless lan connections. The data returned is equivalent to +running C. The parsed data is +passed to a callback function in form of a B +structure. + +The query function has the following prototype: + + int ros_registration_table (ros_connection_t *c, + ros_registration_table_handler_t handler, void *user_data); + +I is the usual connection ocject. I is a pointer to a function with +the following prototype: + + int callback (ros_connection_t *c, + const ros_registration_table_t *r, void *user_data); + +The usual semantics apply: You may not alter I and the memory pointed to by +I is freed after the callback returned. =head1 ERROR HANDLING