netmgr

结构体

struct  netmgr_ifconfig_info
 this struct defines netmgr ifconfig info 更多...
 
struct  netmgr_wifi_ap_info_t
 this struct defines wifi ap info 更多...
 
struct  netmgr_wifi_ap_config_t
 this struct defines wifi ap config 更多...
 
struct  netmgr_config
 netmgr config struct 更多...
 
struct  netmgr_del_config
 netmgr delete config 更多...
 
struct  netmgr_wifi_params
 netmgr wifi params 更多...
 
struct  netmgr_wifi_ap_params
 netmgr wifi ap params 更多...
 
struct  netmgr_wifi_sta_connect_params
 netmgr wifi sta connect params 更多...
 
struct  netmgr_connect_params
 netmgr connect params 更多...
 
struct  netmgr_wifi_network_status_change_t
 this struct defines netmgr wifi status change info 更多...
 
struct  netmgr_msg_t
 this struct defines netmgr message 更多...
 
struct  netmgr_wifi_ap_list_t
 this struct defines netmgr message callback function 更多...
 

宏定义

#define IPADDR_STR_LEN   16
 
#define NETMGR_SSID_MAX_LEN   (32)
 
#define NETMGR_PWD_MAX_LEN   (64)
 
#define NETMGR_BSSID_MAX_LEN   (6)
 
#define MAX_AP_CONFIG_NUM   (3)
 
#define NETMGR_WIFI_METHOD_MAX_LENGTH   (32)
 
#define NETMGR_WIFI_STATUS_MAX_LENGTH   (32)
 
#define NETMGR_WIFI_SSID_MAX_LENGTH   (32)
 
#define NETMGR_WIFI_PASSWORD_MAX_LENGTH   (64)
 

类型定义

typedef struct netmgr_ifconfig_info netmgr_ifconfig_info_t
 this struct defines netmgr ifconfig info 更多...
 
typedef struct netmgr_wifi_ap_config_t netmgr_wifi_config_t
 
typedef struct netmgr_config netmgr_config_t
 netmgr config struct 更多...
 
typedef struct netmgr_del_config netmgr_del_config_t
 netmgr delete config 更多...
 
typedef struct netmgr_wifi_params netmgr_wifi_params_t
 netmgr wifi params 更多...
 
typedef struct netmgr_wifi_ap_params netmgr_wifi_ap_params_t
 netmgr wifi ap params 更多...
 
typedef struct netmgr_wifi_sta_connect_params netmgr_wifi_sta_params_t
 netmgr wifi sta connect params 更多...
 
typedef struct netmgr_connect_params netmgr_connect_params_t
 netmgr connect params 更多...
 
typedef void(* netmgr_msg_cb_t) (netmgr_msg_t *msg)
 this struct defines netmgr message callback function 更多...
 
typedef int netmgr_hdl_t
 
typedef enum netmgr_conn_state netmgr_conn_state_t
 netmgr connection state 更多...
 

枚举

enum  eth_mac_speed_e { ETH_MAC_SPEED_10M , ETH_MAC_SPEED_100M , ETH_MAC_SPEED_1000M }
 ethernet speed type 更多...
 
enum  eth_mac_duplex_e { ETH_MAC_DUPLEX_HALF , ETH_MAC_DUPLEX_FULL }
 ethernet duplex type 更多...
 
enum  netmgr_ssid_format_e { NETMGR_SSID_FORMAT_UTF8 , NETMGR_SSID_FORMAT_GBK }
 ssid string format 更多...
 
enum  netmgr_type_t {
  NETMGR_TYPE_WIFI , NETMGR_TYPE_GPRS , NETMGR_TYPE_NBIOT , NETMGR_TYPE_ETH ,
  NETMGR_TYPE_UNKNOWN , NETMGR_TYPE_MAX
}
 network type 更多...
 
enum  netmgr_msgid_t {
  NETMGR_MSGID_MIN = 0 , NETMGR_MSGID_WIFI_STATUS = NETMGR_MSGID_MIN , NETMGR_MSGID_WIFI_STATUS_FROM_IMPL , NETMGR_MSGID_WIFI_TRACE_FROM_IMPL ,
  NETMGR_MSGID_NETWORK_STATUS , NETMGR_MSGID_ETH_STATUS_FROM_IMPL , NETMGR_MSGID_MAX
}
 netmgr message type 更多...
 
enum  netmgr_wifi_mode_t {
  NETMGR_WIFI_MODE_STA = 0 , NETMGR_WIFI_MODE_AP , NETMGR_WIFI_MODE_APSTA , NETMGR_WIFI_MODE_P2P ,
  NETMGR_WIFI_MODE_UNKNOWN , NETMGR_WIFI_MODE_MAX
}
 netmgr wifi type 更多...
 
enum  netmgr_conn_state {
  CONN_STATE_DISCONNECTING , CONN_STATE_DISCONNECTED , CONN_STATE_CONNECTING , CONN_STATE_CONNECTED ,
  CONN_STATE_OBTAINING_IP , CONN_STATE_NETWORK_CONNECTED , CONN_STATE_FAILED , CONN_STATE_UNKNOWN
}
 netmgr connection state 更多...
 

函数

int netmgr_service_init (utask_t *task)
 net manager init. 更多...
 
void netmgr_service_deinit ()
 net manager deinit 更多...
 
int netmgr_add_dev (const char *name)
 add netmgr dev 更多...
 
netmgr_hdl_t netmgr_get_dev (const char *name)
 get netmgr handler 更多...
 
netmgr_type_t get_hdl_type (netmgr_hdl_t hdl)
 get netmgr dev type 更多...
 
int netmgr_set_ifconfig (netmgr_hdl_t hdl, netmgr_ifconfig_info_t *info)
 set if config information 更多...
 
int netmgr_get_ifconfig (netmgr_hdl_t hdl, netmgr_ifconfig_info_t *info)
 get if config information 更多...
 
void netmgr_set_auto_reconnect (netmgr_hdl_t hdl, bool enable)
 set auto reconnect flag 更多...
 
int netmgr_connect (netmgr_hdl_t hdl, netmgr_connect_params_t *params)
 netmgr connect network 更多...
 
int netmgr_disconnect (netmgr_hdl_t hdl)
 netmgr disconnect network 更多...
 
netmgr_conn_state_t netmgr_get_state (netmgr_hdl_t hdl)
 get state of hdl 更多...
 
int netmgr_save_config (netmgr_hdl_t hdl)
 netmgr save config 更多...
 
int netmgr_get_config (netmgr_hdl_t hdl, netmgr_config_t *config)
 get config information 更多...
 
int netmgr_del_config (netmgr_hdl_t, netmgr_del_config_t *config)
 delete config information 更多...
 
int netmgr_set_msg_cb (netmgr_hdl_t hdl, netmgr_msg_cb_t cb)
 netmgr set message callback 更多...
 
int netmgr_del_msg_cb (netmgr_hdl_t hdl, netmgr_msg_cb_t cb)
 netmgr delete message callback 更多...
 

详细描述

宏定义说明

◆ IPADDR_STR_LEN

#define IPADDR_STR_LEN   16

在文件 netmgr.h34 行定义.

◆ MAX_AP_CONFIG_NUM

#define MAX_AP_CONFIG_NUM   (3)

在文件 netmgr.h60 行定义.

◆ NETMGR_BSSID_MAX_LEN

#define NETMGR_BSSID_MAX_LEN   (6)

在文件 netmgr.h51 行定义.

◆ NETMGR_PWD_MAX_LEN

#define NETMGR_PWD_MAX_LEN   (64)

在文件 netmgr.h47 行定义.

◆ NETMGR_SSID_MAX_LEN

#define NETMGR_SSID_MAX_LEN   (32)

在文件 netmgr.h46 行定义.

◆ NETMGR_WIFI_METHOD_MAX_LENGTH

#define NETMGR_WIFI_METHOD_MAX_LENGTH   (32)

在文件 netmgr.h169 行定义.

◆ NETMGR_WIFI_PASSWORD_MAX_LENGTH

#define NETMGR_WIFI_PASSWORD_MAX_LENGTH   (64)

在文件 netmgr.h172 行定义.

◆ NETMGR_WIFI_SSID_MAX_LENGTH

#define NETMGR_WIFI_SSID_MAX_LENGTH   (32)

在文件 netmgr.h171 行定义.

◆ NETMGR_WIFI_STATUS_MAX_LENGTH

#define NETMGR_WIFI_STATUS_MAX_LENGTH   (32)

在文件 netmgr.h170 行定义.

类型定义说明

◆ netmgr_config_t

netmgr config struct

◆ netmgr_conn_state_t

netmgr connection state

◆ netmgr_connect_params_t

netmgr connect params

◆ netmgr_del_config_t

netmgr delete config

◆ netmgr_hdl_t

typedef int netmgr_hdl_t

在文件 netmgr.h197 行定义.

◆ netmgr_ifconfig_info_t

this struct defines netmgr ifconfig info

◆ netmgr_msg_cb_t

typedef void(* netmgr_msg_cb_t) (netmgr_msg_t *msg)

this struct defines netmgr message callback function

在文件 netmgr.h195 行定义.

◆ netmgr_wifi_ap_params_t

netmgr wifi ap params

◆ netmgr_wifi_config_t

◆ netmgr_wifi_params_t

netmgr wifi params

◆ netmgr_wifi_sta_params_t

netmgr wifi sta connect params

枚举类型说明

◆ eth_mac_duplex_e

ethernet duplex type

枚举值
ETH_MAC_DUPLEX_HALF 
ETH_MAC_DUPLEX_FULL 

在文件 netmgr.h29 行定义.

◆ eth_mac_speed_e

ethernet speed type

枚举值
ETH_MAC_SPEED_10M 
ETH_MAC_SPEED_100M 
ETH_MAC_SPEED_1000M 

在文件 netmgr.h22 行定义.

◆ netmgr_conn_state

netmgr connection state

枚举值
CONN_STATE_DISCONNECTING 
CONN_STATE_DISCONNECTED 
CONN_STATE_CONNECTING 
CONN_STATE_CONNECTED 
CONN_STATE_OBTAINING_IP 
CONN_STATE_NETWORK_CONNECTED 
CONN_STATE_FAILED 
CONN_STATE_UNKNOWN 

在文件 netmgr.h209 行定义.

◆ netmgr_msgid_t

netmgr message type

枚举值
NETMGR_MSGID_MIN 
NETMGR_MSGID_WIFI_STATUS 
NETMGR_MSGID_WIFI_STATUS_FROM_IMPL 
NETMGR_MSGID_WIFI_TRACE_FROM_IMPL 
NETMGR_MSGID_NETWORK_STATUS 
NETMGR_MSGID_ETH_STATUS_FROM_IMPL 
NETMGR_MSGID_MAX 

在文件 netmgr.h93 行定义.

◆ netmgr_ssid_format_e

ssid string format

枚举值
NETMGR_SSID_FORMAT_UTF8 
NETMGR_SSID_FORMAT_GBK 

在文件 netmgr.h55 行定义.

◆ netmgr_type_t

network type

枚举值
NETMGR_TYPE_WIFI 
NETMGR_TYPE_GPRS 
NETMGR_TYPE_NBIOT 
NETMGR_TYPE_ETH 
NETMGR_TYPE_UNKNOWN 
NETMGR_TYPE_MAX 

在文件 netmgr.h83 行定义.

◆ netmgr_wifi_mode_t

netmgr wifi type

枚举值
NETMGR_WIFI_MODE_STA 

WiFi station mode

NETMGR_WIFI_MODE_AP 

WiFi soft-AP mode

NETMGR_WIFI_MODE_APSTA 

WiFi station + soft-AP mode

NETMGR_WIFI_MODE_P2P 

WiFi P2P mode

NETMGR_WIFI_MODE_UNKNOWN 

null mode

NETMGR_WIFI_MODE_MAX 

在文件 netmgr.h104 行定义.

函数说明

◆ get_hdl_type()

netmgr_type_t get_hdl_type ( netmgr_hdl_t  hdl)

get netmgr dev type

参数
[in]hdlnetmgr handle
返回
NETMGR_TYPE_UNKNOWN on failure, others on success.

◆ netmgr_add_dev()

int netmgr_add_dev ( const char *  name)

add netmgr dev

参数
[in]namename of netmgr dev
返回
0 on success, negative error on failure.

◆ netmgr_connect()

int netmgr_connect ( netmgr_hdl_t  hdl,
netmgr_connect_params_t params 
)

netmgr connect network

参数
[in]hdlnetmgr handle
[in]paramsnetmgr connect params
返回
0 on success, others on error

◆ netmgr_del_config()

delete config information

参数
[in]hdlnetmgr handle
[in]confignetmgr config information
返回
0 on success, others on error

◆ netmgr_del_msg_cb()

int netmgr_del_msg_cb ( netmgr_hdl_t  hdl,
netmgr_msg_cb_t  cb 
)

netmgr delete message callback

参数
[in]hdlnetmgr handle
[in]cbnetmgr msg callback
返回
0 on success, others on error

◆ netmgr_disconnect()

int netmgr_disconnect ( netmgr_hdl_t  hdl)

netmgr disconnect network

参数
[in]hdlnetmgr handle
返回
0 on success, others on error

◆ netmgr_get_config()

int netmgr_get_config ( netmgr_hdl_t  hdl,
netmgr_config_t config 
)

get config information

参数
[in]hdlnetmgr handle
[out]confignetmgr config information
返回
0 on success, others on error

◆ netmgr_get_dev()

netmgr_hdl_t netmgr_get_dev ( const char *  name)

get netmgr handler

参数
[in]namename of netmgr dev
返回
negative error on failure, others on success.

◆ netmgr_get_ifconfig()

int netmgr_get_ifconfig ( netmgr_hdl_t  hdl,
netmgr_ifconfig_info_t info 
)

get if config information

参数
[in]hdlnetmgr handle
[out]infoconfig information
返回
0 on success, others on error

◆ netmgr_get_state()

netmgr_conn_state_t netmgr_get_state ( netmgr_hdl_t  hdl)

get state of hdl

参数
[in]hdlnetmgr handle
返回
Please refer to netmgr_conn_state_t

◆ netmgr_save_config()

int netmgr_save_config ( netmgr_hdl_t  hdl)

netmgr save config

参数
[in]hdlnetmgr handle
返回
0 on success, others on error

◆ netmgr_service_deinit()

void netmgr_service_deinit ( )

net manager deinit

◆ netmgr_service_init()

int netmgr_service_init ( utask_t *  task)

net manager init.

参数
[in]taskNULL for current realize.
返回
0 on success, negative error on failure.

◆ netmgr_set_auto_reconnect()

void netmgr_set_auto_reconnect ( netmgr_hdl_t  hdl,
bool  enable 
)

set auto reconnect flag

参数
[in]hdlnetmgr handle
[in]enableenable auto reconnect

◆ netmgr_set_ifconfig()

int netmgr_set_ifconfig ( netmgr_hdl_t  hdl,
netmgr_ifconfig_info_t info 
)

set if config information

参数
[in]hdlnetmgr handle
[in]infoconfig information
返回
>=0 on success, others on error

◆ netmgr_set_msg_cb()

int netmgr_set_msg_cb ( netmgr_hdl_t  hdl,
netmgr_msg_cb_t  cb 
)

netmgr set message callback

参数
[in]hdlnetmgr handle
[in]cbnetmgr msg callback
返回
0 on success, others on error