@@ -128,6 +128,7 @@ struct mdns_info {
128
128
unsigned long ipAddr ;
129
129
char * txt_data ;
130
130
};
131
+
131
132
/******************************************************************************
132
133
* FunctionName : espconn_connect
133
134
* Description : The function given as the connect
@@ -173,6 +174,19 @@ sint8 espconn_accept(struct espconn *espconn);
173
174
174
175
sint8 espconn_create (struct espconn * espconn );
175
176
177
+ /******************************************************************************
178
+ * FunctionName : espconn_sent
179
+ * Description : sent data for client or server
180
+ * Parameters : espconn -- espconn to set for client or server
181
+ * psent -- data to send
182
+ * length -- length of data to send
183
+ * Returns : none
184
+ *******************************************************************************/
185
+
186
+ sint8 espconn_sent (struct espconn * espconn , uint8 * psent , uint16 length );
187
+
188
+ /***** Connetion Settings *******/
189
+
176
190
/******************************************************************************
177
191
* FunctionName : espconn_tcp_get_max_con
178
192
* Description : get the number of simulatenously active TCP connections
@@ -204,7 +218,7 @@ sint8 espconn_tcp_get_max_con_allow(struct espconn *espconn);
204
218
* FunctionName : espconn_tcp_set_max_con_allow
205
219
* Description : set the count of simulatenously active connections on the server
206
220
* Parameters : espconn -- espconn to set the count
207
- * num -- support the connection number
221
+ * num -- support the connection number
208
222
* Returns : result
209
223
*******************************************************************************/
210
224
@@ -214,7 +228,7 @@ sint8 espconn_tcp_set_max_con_allow(struct espconn *espconn, uint8 num);
214
228
* FunctionName : espconn_regist_time
215
229
* Description : used to specify the time that should be called when don't recv data
216
230
* Parameters : espconn -- the espconn used to the connection
217
- * interval -- the timer when don't recv data
231
+ * interval -- the timer when don't recv data
218
232
* Returns : none
219
233
*******************************************************************************/
220
234
@@ -234,12 +248,69 @@ sint8 espconn_get_connection_info(struct espconn *pespconn, remot_info **pcon_in
234
248
* FunctionName : espconn_get_packet_info
235
249
* Description : get the packet info with host
236
250
* Parameters : espconn -- the espconn used to disconnect the connection
237
- * infoarg -- the packet info
251
+ * infoarg -- the packet info
238
252
* Returns : the errur code
239
253
*******************************************************************************/
240
254
241
255
sint8 espconn_get_packet_info (struct espconn * espconn , struct espconn_packet * infoarg );
242
256
257
+ /******************************************************************************
258
+ * FunctionName : espconn_port
259
+ * Description : access port value for client so that we don't end up bouncing
260
+ * all connections at the same time .
261
+ * Parameters : none
262
+ * Returns : access port value
263
+ *******************************************************************************/
264
+
265
+ uint32 espconn_port (void );
266
+
267
+ /******************************************************************************
268
+ * FunctionName : espconn_set_opt
269
+ * Description : access port value for client so that we don't end up bouncing
270
+ * all connections at the same time .
271
+ * Parameters : espconn -- the espconn used to set the connection
272
+ * opt -- the option to set
273
+ * Returns : access port value
274
+ *******************************************************************************/
275
+
276
+ sint8 espconn_set_opt (struct espconn * espconn , uint8 opt );
277
+
278
+ /******************************************************************************
279
+ * FunctionName : espconn_clear_opt
280
+ * Description : clear the option for connections so that we don't end up bouncing
281
+ * all connections at the same time .
282
+ * Parameters : espconn -- the espconn used to set the connection
283
+ * opt -- the option for clear
284
+ * Returns : the result
285
+ *******************************************************************************/
286
+
287
+ sint8 espconn_clear_opt (struct espconn * espconn , uint8 opt );
288
+
289
+ /******************************************************************************
290
+ * FunctionName : espconn_set_keepalive
291
+ * Description : access level value for connection so that we set the value for
292
+ * keep alive
293
+ * Parameters : espconn -- the espconn used to set the connection
294
+ * level -- the connection's level
295
+ * value -- the value of time(s)
296
+ * Returns : access port value
297
+ *******************************************************************************/
298
+
299
+ sint8 espconn_set_keepalive (struct espconn * espconn , uint8 level , void * optarg );
300
+
301
+ /******************************************************************************
302
+ * FunctionName : espconn_get_keepalive
303
+ * Description : access level value for connection so that we get the value for
304
+ * keep alive
305
+ * Parameters : espconn -- the espconn used to get the connection
306
+ * level -- the connection's level
307
+ * Returns : access keep alive value
308
+ *******************************************************************************/
309
+
310
+ sint8 espconn_get_keepalive (struct espconn * espconn , uint8 level , void * optarg );
311
+
312
+ /***** CALLBACKS *******/
313
+
243
314
/******************************************************************************
244
315
* FunctionName : espconn_regist_sentcb
245
316
* Description : Used to specify the function that should be called when data
@@ -253,9 +324,9 @@ sint8 espconn_get_packet_info(struct espconn *espconn, struct espconn_packet* in
253
324
sint8 espconn_regist_sentcb (struct espconn * espconn , espconn_sent_callback sent_cb );
254
325
255
326
/******************************************************************************
256
- * FunctionName : espconn_regist_sentcb
327
+ * FunctionName : espconn_regist_write_finish
257
328
* Description : Used to specify the function that should be called when data
258
- * has been successfully delivered to the remote host.
329
+ * has been successfully written to the send buffer
259
330
* Parameters : espconn -- espconn to set the sent callback
260
331
* sent_cb -- sent callback function to call for this espconn
261
332
* when data is successfully sent
@@ -264,17 +335,6 @@ sint8 espconn_regist_sentcb(struct espconn *espconn, espconn_sent_callback sent_
264
335
265
336
sint8 espconn_regist_write_finish (struct espconn * espconn , espconn_connect_callback write_finish_fn );
266
337
267
- /******************************************************************************
268
- * FunctionName : espconn_sent
269
- * Description : sent data for client or server
270
- * Parameters : espconn -- espconn to set for client or server
271
- * psent -- data to send
272
- * length -- length of data to send
273
- * Returns : none
274
- *******************************************************************************/
275
-
276
- sint8 espconn_sent (struct espconn * espconn , uint8 * psent , uint16 length );
277
-
278
338
/******************************************************************************
279
339
* FunctionName : espconn_regist_connectcb
280
340
* Description : used to specify the function that should be called when
@@ -318,59 +378,7 @@ sint8 espconn_regist_reconcb(struct espconn *espconn, espconn_reconnect_callback
318
378
319
379
sint8 espconn_regist_disconcb (struct espconn * espconn , espconn_connect_callback discon_cb );
320
380
321
- /******************************************************************************
322
- * FunctionName : espconn_port
323
- * Description : access port value for client so that we don't end up bouncing
324
- * all connections at the same time .
325
- * Parameters : none
326
- * Returns : access port value
327
- *******************************************************************************/
328
-
329
- uint32 espconn_port (void );
330
-
331
- /******************************************************************************
332
- * FunctionName : espconn_set_opt
333
- * Description : access port value for client so that we don't end up bouncing
334
- * all connections at the same time .
335
- * Parameters : none
336
- * Returns : access port value
337
- *******************************************************************************/
338
-
339
- sint8 espconn_set_opt (struct espconn * espconn , uint8 opt );
340
-
341
- /******************************************************************************
342
- * FunctionName : espconn_clear_opt
343
- * Description : clear the option for connections so that we don't end up bouncing
344
- * all connections at the same time .
345
- * Parameters : espconn -- the espconn used to set the connection
346
- * opt -- the option for clear
347
- * Returns : the result
348
- *******************************************************************************/
349
-
350
- sint8 espconn_clear_opt (struct espconn * espconn , uint8 opt );
351
-
352
- /******************************************************************************
353
- * FunctionName : espconn_set_keepalive
354
- * Description : access level value for connection so that we set the value for
355
- * keep alive
356
- * Parameters : espconn -- the espconn used to set the connection
357
- * level -- the connection's level
358
- * value -- the value of time(s)
359
- * Returns : access port value
360
- *******************************************************************************/
361
-
362
- sint8 espconn_set_keepalive (struct espconn * espconn , uint8 level , void * optarg );
363
-
364
- /******************************************************************************
365
- * FunctionName : espconn_get_keepalive
366
- * Description : access level value for connection so that we get the value for
367
- * keep alive
368
- * Parameters : espconn -- the espconn used to get the connection
369
- * level -- the connection's level
370
- * Returns : access keep alive value
371
- *******************************************************************************/
372
-
373
- sint8 espconn_get_keepalive (struct espconn * espconn , uint8 level , void * optarg );
381
+ /***** DNS *******/
374
382
375
383
/******************************************************************************
376
384
* TypedefName : dns_found_callback
@@ -405,6 +413,8 @@ typedef void (*dns_found_callback)(const char *name, ip_addr_t *ipaddr, void *ca
405
413
406
414
err_t espconn_gethostbyname (struct espconn * pespconn , const char * hostname , ip_addr_t * addr , dns_found_callback found );
407
415
416
+ /***** SSL *******/
417
+
408
418
/******************************************************************************
409
419
* FunctionName : espconn_encry_connect
410
420
* Description : The function given as connection
@@ -427,7 +437,7 @@ sint8 espconn_secure_disconnect(struct espconn *espconn);
427
437
* FunctionName : espconn_encry_sent
428
438
* Description : sent data for client or server
429
439
* Parameters : espconn -- espconn to set for client or server
430
- * psent -- data to send
440
+ * psent -- data to send
431
441
* length -- length of data to send
432
442
* Returns : none
433
443
*******************************************************************************/
@@ -438,8 +448,8 @@ sint8 espconn_secure_sent(struct espconn *espconn, uint8 *psent, uint16 length);
438
448
* FunctionName : espconn_secure_set_size
439
449
* Description : set the buffer size for client or server
440
450
* Parameters : level -- set for client or server
441
- * 1: client,2:server,3:client and server
442
- * size -- buffer size
451
+ * 1: client,2:server,3:client and server
452
+ * size -- buffer size
443
453
* Returns : true or false
444
454
*******************************************************************************/
445
455
@@ -449,7 +459,7 @@ bool espconn_secure_set_size(uint8 level, uint16 size);
449
459
* FunctionName : espconn_secure_get_size
450
460
* Description : get buffer size for client or server
451
461
* Parameters : level -- set for client or server
452
- * 1: client,2:server,3:client and server
462
+ * 1: client,2:server,3:client and server
453
463
* Returns : buffer size for client or server
454
464
*******************************************************************************/
455
465
@@ -464,23 +474,7 @@ sint16 espconn_secure_get_size(uint8 level);
464
474
465
475
sint8 espconn_secure_accept (struct espconn * espconn );
466
476
467
- /******************************************************************************
468
- * FunctionName : espconn_igmp_join
469
- * Description : join a multicast group
470
- * Parameters : host_ip -- the ip address of udp server
471
- * multicast_ip -- multicast ip given by user
472
- * Returns : none
473
- *******************************************************************************/
474
- sint8 espconn_igmp_join (ip_addr_t * host_ip , ip_addr_t * multicast_ip );
475
-
476
- /******************************************************************************
477
- * FunctionName : espconn_igmp_leave
478
- * Description : leave a multicast group
479
- * Parameters : host_ip -- the ip address of udp server
480
- * multicast_ip -- multicast ip given by user
481
- * Returns : none
482
- *******************************************************************************/
483
- sint8 espconn_igmp_leave (ip_addr_t * host_ip , ip_addr_t * multicast_ip );
477
+ /***** TCP RX HOLD *******/
484
478
485
479
/******************************************************************************
486
480
* FunctionName : espconn_recv_hold
@@ -498,11 +492,33 @@ sint8 espconn_recv_hold(struct espconn *pespconn);
498
492
*******************************************************************************/
499
493
sint8 espconn_recv_unhold (struct espconn * pespconn );
500
494
495
+ /***** IGMP *******/
496
+
497
+ /******************************************************************************
498
+ * FunctionName : espconn_igmp_join
499
+ * Description : join a multicast group
500
+ * Parameters : host_ip -- the ip address of udp server
501
+ * multicast_ip -- multicast ip given by user
502
+ * Returns : none
503
+ *******************************************************************************/
504
+ sint8 espconn_igmp_join (ip_addr_t * host_ip , ip_addr_t * multicast_ip );
505
+
506
+ /******************************************************************************
507
+ * FunctionName : espconn_igmp_leave
508
+ * Description : leave a multicast group
509
+ * Parameters : host_ip -- the ip address of udp server
510
+ * multicast_ip -- multicast ip given by user
511
+ * Returns : none
512
+ *******************************************************************************/
513
+ sint8 espconn_igmp_leave (ip_addr_t * host_ip , ip_addr_t * multicast_ip );
514
+
515
+ /***** mDNS *******/
516
+
501
517
/******************************************************************************
502
518
* FunctionName : espconn_mdns_init
503
519
* Description : register a device with mdns
504
520
* Parameters : ipAddr -- the ip address of device
505
- * hostname -- the hostname of device
521
+ * hostname -- the hostname of device
506
522
* Returns : none
507
523
*******************************************************************************/
508
524
0 commit comments