Commit 1ca5e27d authored by 's avatar

mapi man page update for mapi_get_device_info


git-svn-id: file:///home/svn/mapi/trunk@1253 8d5bb341-7cf1-0310-8cf6-ba355fef3186
parent 6feebc86
......@@ -46,6 +46,10 @@ MAPI \- Monitoring Application Programming Interface
.br
.BI "int mapi_get_next_function_info(int " fd ", int " fid ", mapi_function_info_t *" info ");"
.br
.BI "int mapi_get_device_info(int " devid ", mapi_device_info_t *" info ");"
.br
.BI "int mapi_get_next_device_info(int " devid ", mapi_device_info_t *" info ");"
.br
.BI "int mapi_get_scope_size(int " fd ");"
.br
.BI "int mapi_is_remote(int " fd ");"
......@@ -401,6 +405,51 @@ which has been applied to the network flow denoted by
.IR fd .
Enough memory for the data must have been previously allocated.
.sp
.BI "int mapi_get_device_info(int " devid ", mapi_device_info_t *" info ");"
.br
.B mapi_get_device_info()
fills the structure
.I info
with information regarding the device with id
.IR devid .
The
.I info
argument is a
.B mapi_device_info_t
struct as specified in mapi.h:
.sp
.nf
typedef struct mapi_device_info {
int id;
char device[MAPI_STR_LENGTH];
char name[MAPI_STR_LENGTH];
char alias[MAPI_STR_LENGTH];
char description[1024];
int link_speed;
int mpls;
int vlan;
} mapi_device_info_t;
.fi
.sp
Enough memory for the data must have been previously allocated.
In case o DiMAPI,
.IR devid
denotes a network scope (list of one or more monitoring devices) and
.I info
is a table with one
.B mapi_devce_info_t
instance for each device.
.sp
.BI "int mapi_get_next_device_info(int " devid ", mapi_device_info_t *" info ");"
.br
.B mapi_get_next_device_info()
fills the structure
.I info
with information regarding the consecutive device with a device descriptor greater
than
.IR devid .
Enough memory for the data must have been previously allocated.
.sp
.BI "int mapi_get_scope_size(int " fd ");"
.br
.B mapi_get_scope_size()
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment