ivampiresp/Spdk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

include/net.h: add comments for public APIs

Browse Source 
Change-Id: I7a42e1978402ac552b25db0c4aa6d2b30ba6d7f7
Signed-off-by: Yanbo Zhou <yanbo.zhou@intel.com>
Reviewed-on: https://review.gerrithub.io/406299
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
This commit is contained in:
Yanbo Zhou 2018-04-04 16:24:38 +08:00 committed by Jim Harris
parent e86b174ed1
commit 635c7f3d20
1 changed files with 46 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
include/spdk/net.h
View File

@ -57,6 +57,11 @@ struct spdk_net_framework {
STAILQ_ENTRY(spdk_net_framework) link; STAILQ_ENTRY(spdk_net_framework) link;
}; };
/**
* Register a net framework.
*
* \param frame Net framework to register.
*/
void spdk_net_framework_register(struct spdk_net_framework *frame); void spdk_net_framework_register(struct spdk_net_framework *frame);
#define SPDK_NET_FRAMEWORK_REGISTER(name, frame) \ #define SPDK_NET_FRAMEWORK_REGISTER(name, frame) \
@ -65,10 +70,28 @@ static void __attribute__((constructor)) net_framework_register_##name(void) \
spdk_net_framework_register(frame); \ spdk_net_framework_register(frame); \
} }
/**
* Initialize the network interfaces by getting information through netlink socket.
*
* \return 0 on success, 1 on failure.
*/
int spdk_interface_init(void); int spdk_interface_init(void);
/**
* Destroy the network interfaces.
*/
void spdk_interface_destroy(void); void spdk_interface_destroy(void);
/**
* Start all registered frameworks.
*
* \return 0 on success.
*/
int spdk_net_framework_start(void); int spdk_net_framework_start(void);
/**
* Stop all registered frameworks.
*/
void spdk_net_framework_fini(void); void spdk_net_framework_fini(void);
#define SPDK_IFNAMSIZE 32 #define SPDK_IFNAMSIZE 32
@ -82,8 +105,31 @@ struct spdk_interface {
TAILQ_ENTRY(spdk_interface) tailq; TAILQ_ENTRY(spdk_interface) tailq;
}; };
/**
* Add an ip address to the network interface.
*
* \param ifc_index Index of the network interface.
* \param ip_addr Ip address to add.
*
* \return 0 on success, -1 on failure.
*/
int spdk_interface_add_ip_address(int ifc_index, char *ip_addr); int spdk_interface_add_ip_address(int ifc_index, char *ip_addr);
/**
* Delete an ip address from the network interface.
*
* \param ifc_index Index of the network interface.
* \param ip_addr Ip address to delete.
*
* \return 0 on success, -1 on failure.
*/
int spdk_interface_delete_ip_address(int ifc_index, char *ip_addr); int spdk_interface_delete_ip_address(int ifc_index, char *ip_addr);
/**
* Get the list of all the network interfaces.
*
* \return a pointer to the head of the linked list of all the network interfaces.
*/
void *spdk_interface_get_list(void); void *spdk_interface_get_list(void);
#ifdef __cplusplus #ifdef __cplusplus