ESP8266 Centre + NB
结构体 | 宏定义 | 类型定义 | 枚举 | 函数
espconn.h 文件参考
此图展示该文件直接或间接的被哪些文件引用了:

浏览源代码.

结构体

struct  _esp_tcp
 
struct  _esp_udp
 
struct  _remot_info
 
struct  espconn
 
struct  espconn_packet
 
struct  mdns_info
 

宏定义

#define ESPCONN_OK   0 /* No error, everything OK. */
 
#define ESPCONN_MEM   -1 /* Out of memory error. */
 
#define ESPCONN_TIMEOUT   -3 /* Timeout. */
 
#define ESPCONN_RTE   -4 /* Routing problem. */
 
#define ESPCONN_INPROGRESS   -5 /* Operation in progress */
 
#define ESPCONN_MAXNUM   -7 /* Total number exceeds the set maximum*/
 
#define ESPCONN_ABRT   -8 /* Connection aborted. */
 
#define ESPCONN_RST   -9 /* Connection reset. */
 
#define ESPCONN_CLSD   -10 /* Connection closed. */
 
#define ESPCONN_CONN   -11 /* Not connected. */
 
#define ESPCONN_ARG   -12 /* Illegal argument. */
 
#define ESPCONN_IF   -14 /* UDP send error */
 
#define ESPCONN_ISCONN   -15 /* Already connected. */
 
#define ESPCONN_HANDSHAKE   -28 /* ssl handshake failed */
 
#define ESPCONN_SSL_INVALID_DATA   -61 /* ssl application invalid */
 

类型定义

typedef sint8 err_t
 
typedef void * espconn_handle
 
typedef void(* espconn_connect_callback )(void *arg)
 
typedef void(* espconn_reconnect_callback )(void *arg, sint8 err)
 
typedef struct _esp_tcp esp_tcp
 
typedef struct _esp_udp esp_udp
 
typedef struct _remot_info remot_info
 
typedef void(* espconn_recv_callback )(void *arg, char *pdata, unsigned short len)
 
typedef void(* espconn_sent_callback )(void *arg)
 
typedef void(* dns_found_callback )(const char *name, ip_addr_t *ipaddr, void *callback_arg)
 

枚举

enum  espconn_type { ESPCONN_INVALID = 0, ESPCONN_TCP = 0x10, ESPCONN_UDP = 0x20 }
 
enum  espconn_state {
  ESPCONN_NONE, ESPCONN_WAIT, ESPCONN_LISTEN, ESPCONN_CONNECT,
  ESPCONN_WRITE, ESPCONN_READ, ESPCONN_CLOSE
}
 
enum  espconn_option {
  ESPCONN_START = 0x00, ESPCONN_REUSEADDR = 0x01, ESPCONN_NODELAY = 0x02, ESPCONN_COPY = 0x04,
  ESPCONN_KEEPALIVE = 0x08, ESPCONN_END
}
 
enum  espconn_level { ESPCONN_KEEPIDLE, ESPCONN_KEEPINTVL, ESPCONN_KEEPCNT }
 
enum  {
  ESPCONN_IDLE = 0, ESPCONN_CLIENT, ESPCONN_SERVER, ESPCONN_BOTH,
  ESPCONN_MAX
}
 

函数

sint8 espconn_connect (struct espconn *espconn)
 
sint8 espconn_disconnect (struct espconn *espconn)
 
sint8 espconn_delete (struct espconn *espconn)
 
sint8 espconn_accept (struct espconn *espconn)
 
sint8 espconn_create (struct espconn *espconn)
 
uint8 espconn_tcp_get_max_con (void)
 
sint8 espconn_tcp_set_max_con (uint8 num)
 
sint8 espconn_tcp_get_max_con_allow (struct espconn *espconn)
 
sint8 espconn_tcp_set_max_con_allow (struct espconn *espconn, uint8 num)
 
sint8 espconn_regist_time (struct espconn *espconn, uint32 interval, uint8 type_flag)
 
sint8 espconn_get_connection_info (struct espconn *pespconn, remot_info **pcon_info, uint8 typeflags)
 
sint8 espconn_get_packet_info (struct espconn *espconn, struct espconn_packet *infoarg)
 
sint8 espconn_regist_sentcb (struct espconn *espconn, espconn_sent_callback sent_cb)
 
sint8 espconn_regist_write_finish (struct espconn *espconn, espconn_connect_callback write_finish_fn)
 
sint8 espconn_send (struct espconn *espconn, uint8 *psent, uint16 length)
 
sint8 espconn_sent (struct espconn *espconn, uint8 *psent, uint16 length)
 
sint16 espconn_sendto (struct espconn *espconn, uint8 *psent, uint16 length)
 
sint8 espconn_regist_connectcb (struct espconn *espconn, espconn_connect_callback connect_cb)
 
sint8 espconn_regist_recvcb (struct espconn *espconn, espconn_recv_callback recv_cb)
 
sint8 espconn_regist_reconcb (struct espconn *espconn, espconn_reconnect_callback recon_cb)
 
sint8 espconn_regist_disconcb (struct espconn *espconn, espconn_connect_callback discon_cb)
 
uint32 espconn_port (void)
 
sint8 espconn_set_opt (struct espconn *espconn, uint8 opt)
 
sint8 espconn_clear_opt (struct espconn *espconn, uint8 opt)
 
sint8 espconn_set_keepalive (struct espconn *espconn, uint8 level, void *optarg)
 
sint8 espconn_get_keepalive (struct espconn *espconn, uint8 level, void *optarg)
 
err_t espconn_gethostbyname (struct espconn *pespconn, const char *hostname, ip_addr_t *addr, dns_found_callback found)
 
sint8 espconn_abort (struct espconn *espconn)
 
sint8 espconn_secure_connect (struct espconn *espconn)
 
sint8 espconn_secure_disconnect (struct espconn *espconn)
 
sint8 espconn_secure_send (struct espconn *espconn, uint8 *psent, uint16 length)
 
sint8 espconn_secure_sent (struct espconn *espconn, uint8 *psent, uint16 length)
 
bool espconn_secure_set_size (uint8 level, uint16 size)
 
sint16 espconn_secure_get_size (uint8 level)
 
bool espconn_secure_ca_enable (uint8 level, uint32 flash_sector)
 
bool espconn_secure_ca_disable (uint8 level)
 
bool espconn_secure_cert_req_enable (uint8 level, uint32 flash_sector)
 
bool espconn_secure_cert_req_disable (uint8 level)
 
bool espconn_secure_set_default_certificate (const uint8 *certificate, uint16 length)
 
bool espconn_secure_set_default_private_key (const uint8 *private_key, uint16 length)
 
sint8 espconn_secure_accept (struct espconn *espconn)
 
sint8 espconn_secure_delete (struct espconn *espconn)
 
sint8 espconn_igmp_join (ip_addr_t *host_ip, ip_addr_t *multicast_ip)
 
sint8 espconn_igmp_leave (ip_addr_t *host_ip, ip_addr_t *multicast_ip)
 
sint8 espconn_recv_hold (struct espconn *pespconn)
 
sint8 espconn_recv_unhold (struct espconn *pespconn)
 
void espconn_mdns_init (struct mdns_info *info)
 
void espconn_mdns_close (void)
 
void espconn_mdns_server_register (void)
 
void espconn_mdns_server_unregister (void)
 
char * espconn_mdns_get_servername (void)
 
void espconn_mdns_set_servername (const char *name)
 
void espconn_mdns_set_hostname (char *name)
 
char * espconn_mdns_get_hostname (void)
 
void espconn_mdns_disable (void)
 
void espconn_mdns_enable (void)
 
void espconn_dns_setserver (char numdns, ip_addr_t *dnsserver)
 

宏定义说明

#define ESPCONN_OK   0 /* No error, everything OK. */
#define ESPCONN_MEM   -1 /* Out of memory error. */
#define ESPCONN_TIMEOUT   -3 /* Timeout. */
#define ESPCONN_RTE   -4 /* Routing problem. */
#define ESPCONN_INPROGRESS   -5 /* Operation in progress */
#define ESPCONN_MAXNUM   -7 /* Total number exceeds the set maximum*/
#define ESPCONN_ABRT   -8 /* Connection aborted. */
#define ESPCONN_RST   -9 /* Connection reset. */
#define ESPCONN_CLSD   -10 /* Connection closed. */
#define ESPCONN_CONN   -11 /* Not connected. */
#define ESPCONN_ARG   -12 /* Illegal argument. */
#define ESPCONN_IF   -14 /* UDP send error */
#define ESPCONN_ISCONN   -15 /* Already connected. */
#define ESPCONN_HANDSHAKE   -28 /* ssl handshake failed */
#define ESPCONN_SSL_INVALID_DATA   -61 /* ssl application invalid */

类型定义说明

typedef sint8 err_t
typedef void* espconn_handle
typedef void(* espconn_connect_callback)(void *arg)
typedef void(* espconn_reconnect_callback)(void *arg, sint8 err)
typedef struct _esp_tcp esp_tcp
typedef struct _esp_udp esp_udp
typedef struct _remot_info remot_info
typedef void(* espconn_recv_callback)(void *arg, char *pdata, unsigned short len)

A callback prototype to inform about events for a espconn

typedef void(* espconn_sent_callback)(void *arg)
typedef void(* dns_found_callback)(const char *name, ip_addr_t *ipaddr, void *callback_arg)

枚举类型说明

enum espconn_type

Protocol family and type of the espconn

枚举值
ESPCONN_INVALID 
ESPCONN_TCP 
ESPCONN_UDP 
56  {
57  ESPCONN_INVALID = 0,
58  /* ESPCONN_TCP Group */
59  ESPCONN_TCP = 0x10,
60  /* ESPCONN_UDP Group */
61  ESPCONN_UDP = 0x20,
62 };
ESPCONN_UDP
Definition: espconn.h:61
ESPCONN_INVALID
Definition: espconn.h:57
ESPCONN_TCP
Definition: espconn.h:59
enum espconn_state

Current state of the espconn. Non-TCP espconn are always in state ESPCONN_NONE!

枚举值
ESPCONN_NONE 
ESPCONN_WAIT 
ESPCONN_LISTEN 
ESPCONN_CONNECT 
ESPCONN_WRITE 
ESPCONN_READ 
ESPCONN_CLOSE 
65  {
66  ESPCONN_NONE,
67  ESPCONN_WAIT,
68  ESPCONN_LISTEN,
69  ESPCONN_CONNECT,
70  ESPCONN_WRITE,
71  ESPCONN_READ,
72  ESPCONN_CLOSE
73 };
ESPCONN_NONE
Definition: espconn.h:66
ESPCONN_READ
Definition: espconn.h:71
ESPCONN_WRITE
Definition: espconn.h:70
ESPCONN_WAIT
Definition: espconn.h:67
ESPCONN_CONNECT
Definition: espconn.h:69
ESPCONN_LISTEN
Definition: espconn.h:68
ESPCONN_CLOSE
Definition: espconn.h:72
enum espconn_option
枚举值
ESPCONN_START 
ESPCONN_REUSEADDR 
ESPCONN_NODELAY 
ESPCONN_COPY 
ESPCONN_KEEPALIVE 
ESPCONN_END 
120  {
121  ESPCONN_START = 0x00,
122  ESPCONN_REUSEADDR = 0x01,
123  ESPCONN_NODELAY = 0x02,
124  ESPCONN_COPY = 0x04,
125  ESPCONN_KEEPALIVE = 0x08,
126  ESPCONN_END
127 };
ESPCONN_REUSEADDR
Definition: espconn.h:122
ESPCONN_KEEPALIVE
Definition: espconn.h:125
ESPCONN_NODELAY
Definition: espconn.h:123
ESPCONN_END
Definition: espconn.h:126
ESPCONN_COPY
Definition: espconn.h:124
ESPCONN_START
Definition: espconn.h:121
enum espconn_level
枚举值
ESPCONN_KEEPIDLE 
ESPCONN_KEEPINTVL 
ESPCONN_KEEPCNT 
129  {
130  ESPCONN_KEEPIDLE,
131  ESPCONN_KEEPINTVL,
132  ESPCONN_KEEPCNT
133 };
ESPCONN_KEEPINTVL
Definition: espconn.h:131
ESPCONN_KEEPCNT
Definition: espconn.h:132
ESPCONN_KEEPIDLE
Definition: espconn.h:130
anonymous enum
枚举值
ESPCONN_IDLE 
ESPCONN_CLIENT 
ESPCONN_SERVER 
ESPCONN_BOTH 
ESPCONN_MAX 
135  {
136  ESPCONN_IDLE = 0,
137  ESPCONN_CLIENT,
138  ESPCONN_SERVER,
139  ESPCONN_BOTH,
140  ESPCONN_MAX
141 };
ESPCONN_SERVER
Definition: espconn.h:138
ESPCONN_MAX
Definition: espconn.h:140
ESPCONN_CLIENT
Definition: espconn.h:137
ESPCONN_IDLE
Definition: espconn.h:136
ESPCONN_BOTH
Definition: espconn.h:139

函数说明

sint8 espconn_connect ( struct espconn *  espconn)

这是这个函数的调用关系图:

sint8 espconn_disconnect ( struct espconn *  espconn)

这是这个函数的调用关系图:

sint8 espconn_delete ( struct espconn *  espconn)
sint8 espconn_accept ( struct espconn *  espconn)

这是这个函数的调用关系图:

sint8 espconn_create ( struct espconn *  espconn)
uint8 espconn_tcp_get_max_con ( void  )
sint8 espconn_tcp_set_max_con ( uint8  num)
sint8 espconn_tcp_get_max_con_allow ( struct espconn *  espconn)
sint8 espconn_tcp_set_max_con_allow ( struct espconn *  espconn,
uint8  num 
)
sint8 espconn_regist_time ( struct espconn *  espconn,
uint32  interval,
uint8  type_flag 
)

这是这个函数的调用关系图:

sint8 espconn_get_connection_info ( struct espconn *  pespconn,
remot_info **  pcon_info,
uint8  typeflags 
)
sint8 espconn_get_packet_info ( struct espconn *  espconn,
struct espconn_packet *  infoarg 
)
sint8 espconn_regist_sentcb ( struct espconn *  espconn,
espconn_sent_callback  sent_cb 
)
sint8 espconn_regist_write_finish ( struct espconn *  espconn,
espconn_connect_callback  write_finish_fn 
)
sint8 espconn_send ( struct espconn *  espconn,
uint8 *  psent,
uint16  length 
)

这是这个函数的调用关系图:

sint8 espconn_sent ( struct espconn *  espconn,
uint8 *  psent,
uint16  length 
)
sint16 espconn_sendto ( struct espconn *  espconn,
uint8 *  psent,
uint16  length 
)
sint8 espconn_regist_connectcb ( struct espconn *  espconn,
espconn_connect_callback  connect_cb 
)

这是这个函数的调用关系图:

sint8 espconn_regist_recvcb ( struct espconn *  espconn,
espconn_recv_callback  recv_cb 
)
sint8 espconn_regist_reconcb ( struct espconn *  espconn,
espconn_reconnect_callback  recon_cb 
)
sint8 espconn_regist_disconcb ( struct espconn *  espconn,
espconn_connect_callback  discon_cb 
)
uint32 espconn_port ( void  )

这是这个函数的调用关系图:

sint8 espconn_set_opt ( struct espconn *  espconn,
uint8  opt 
)
sint8 espconn_clear_opt ( struct espconn *  espconn,
uint8  opt 
)
sint8 espconn_set_keepalive ( struct espconn *  espconn,
uint8  level,
void *  optarg 
)
sint8 espconn_get_keepalive ( struct espconn *  espconn,
uint8  level,
void *  optarg 
)
err_t espconn_gethostbyname ( struct espconn *  pespconn,
const char *  hostname,
ip_addr_t *  addr,
dns_found_callback  found 
)
sint8 espconn_abort ( struct espconn *  espconn)
sint8 espconn_secure_connect ( struct espconn *  espconn)
sint8 espconn_secure_disconnect ( struct espconn *  espconn)
sint8 espconn_secure_send ( struct espconn *  espconn,
uint8 *  psent,
uint16  length 
)
sint8 espconn_secure_sent ( struct espconn *  espconn,
uint8 *  psent,
uint16  length 
)
bool espconn_secure_set_size ( uint8  level,
uint16  size 
)
sint16 espconn_secure_get_size ( uint8  level)
bool espconn_secure_ca_enable ( uint8  level,
uint32  flash_sector 
)
bool espconn_secure_ca_disable ( uint8  level)
bool espconn_secure_cert_req_enable ( uint8  level,
uint32  flash_sector 
)
bool espconn_secure_cert_req_disable ( uint8  level)
bool espconn_secure_set_default_certificate ( const uint8 *  certificate,
uint16  length 
)
bool espconn_secure_set_default_private_key ( const uint8 *  private_key,
uint16  length 
)
sint8 espconn_secure_accept ( struct espconn *  espconn)
sint8 espconn_secure_delete ( struct espconn *  espconn)
sint8 espconn_igmp_join ( ip_addr_t *  host_ip,
ip_addr_t *  multicast_ip 
)
sint8 espconn_igmp_leave ( ip_addr_t *  host_ip,
ip_addr_t *  multicast_ip 
)
sint8 espconn_recv_hold ( struct espconn *  pespconn)
sint8 espconn_recv_unhold ( struct espconn *  pespconn)
void espconn_mdns_init ( struct mdns_info *  info)
void espconn_mdns_close ( void  )
void espconn_mdns_server_register ( void  )
void espconn_mdns_server_unregister ( void  )
char* espconn_mdns_get_servername ( void  )
void espconn_mdns_set_servername ( const char *  name)
void espconn_mdns_set_hostname ( char *  name)
char* espconn_mdns_get_hostname ( void  )
void espconn_mdns_disable ( void  )
void espconn_mdns_enable ( void  )
void espconn_dns_setserver ( char  numdns,
ip_addr_t *  dnsserver 
)
生成于 2020年 二月 22日 星期六 16:45:15 , 为 ESP8266 Centre + NB使用   doxygen 1.8.6