mirror/lwip
1
0
Fork 0
mirror of https://github.com/lwip-tcpip/lwip.git synced 2024-07-02 19:08:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rename tcpip_trycallback() tcpip_callbackmsg_trycallback() to avoid confusion with tcpip_try_callback()

Browse Source 
Add tcpip_callbackmsg_new(), tcpip_callbackmsg_delete(), tcpip_callbackmsg_trycallback() to documentation
This commit is contained in:
Dirk Ziegelmeier 2018-01-04 08:23:49 +01:00
parent 6b2ef1a89b
commit b16f5f0e19
3 changed files with 23 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
UPGRADING
View File

@ -10,6 +10,9 @@ with newer versions.
++ Application changes: ++ Application changes:
* tcpip_trycallback() was renamed to tcpip_callbackmsg_trycallback() to avoid confusion
with tcpip_try_callback()
* MDNS: Functions mdns_resp_add_netif() and mdns_resp_add_service() do not automatically announce * MDNS: Functions mdns_resp_add_netif() and mdns_resp_add_service() do not automatically announce
any more. Users need to call mdns_resp_announce() after adding netifs or services. any more. Users need to call mdns_resp_announce() after adding netifs or services.

25
src/api/tcpip.c
View File

@ -473,12 +473,20 @@ tcpip_api_call(tcpip_api_call_fn fn, struct tcpip_api_call_data *call)
} }
/** /**
* @ingroup lwip_os
* Allocate a structure for a static callback message and initialize it. * Allocate a structure for a static callback message and initialize it.
* This is intended to be used to send "static" messages from interrupt context. * The message has a special type such that lwIP never frees it.
* * This is intended to be used to send "static" messages from interrupt context,
* e.g. the message is allocated once and posted several times from an IRQ
* using tcpip_callbackmsg_trycallback().
* Example usage: Trigger execution of an ethernet IRQ DPC routine in lwIP thread context.
*
* @param function the function to call * @param function the function to call
* @param ctx parameter passed to function * @param ctx parameter passed to function
* @return a struct pointer to pass to tcpip_trycallback(). * @return a struct pointer to pass to tcpip_callbackmsg_trycallback().
*
* @see tcpip_callbackmsg_trycallback()
* @see tcpip_callbackmsg_delete()
*/ */
struct tcpip_callback_msg * struct tcpip_callback_msg *
tcpip_callbackmsg_new(tcpip_callback_fn function, void *ctx) tcpip_callbackmsg_new(tcpip_callback_fn function, void *ctx)
@ -494,9 +502,12 @@ tcpip_callbackmsg_new(tcpip_callback_fn function, void *ctx)
} }
/** /**
* @ingroup lwip_os
* Free a callback message allocated by tcpip_callbackmsg_new(). * Free a callback message allocated by tcpip_callbackmsg_new().
* *
* @param msg the message to free * @param msg the message to free
*
* @see tcpip_callbackmsg_new()
*/ */
void void
tcpip_callbackmsg_delete(struct tcpip_callback_msg *msg) tcpip_callbackmsg_delete(struct tcpip_callback_msg *msg)
@ -505,14 +516,16 @@ tcpip_callbackmsg_delete(struct tcpip_callback_msg *msg)
} }
/** /**
* Try to post a callback-message to the tcpip_thread mbox * @ingroup lwip_os
* This is intended to be used to send "static" messages from interrupt context. * Try to post a callback-message to the tcpip_thread mbox.
* *
* @param msg pointer to the message to post * @param msg pointer to the message to post
* @return sys_mbox_trypost() return code * @return sys_mbox_trypost() return code
*
* @see tcpip_callbackmsg_new()
*/ */
err_t err_t
tcpip_trycallback(struct tcpip_callback_msg *msg) tcpip_callbackmsg_trycallback(struct tcpip_callback_msg *msg)
{ {
LWIP_ASSERT("Invalid mbox", sys_mbox_valid_val(mbox)); LWIP_ASSERT("Invalid mbox", sys_mbox_valid_val(mbox));
return sys_mbox_trypost(&mbox, msg); return sys_mbox_trypost(&mbox, msg);

2
src/include/lwip/tcpip.h
View File

@ -88,7 +88,7 @@ err_t tcpip_callback(tcpip_callback_fn function, void *ctx);
struct tcpip_callback_msg* tcpip_callbackmsg_new(tcpip_callback_fn function, void *ctx); struct tcpip_callback_msg* tcpip_callbackmsg_new(tcpip_callback_fn function, void *ctx);
void tcpip_callbackmsg_delete(struct tcpip_callback_msg* msg); void tcpip_callbackmsg_delete(struct tcpip_callback_msg* msg);
err_t tcpip_trycallback(struct tcpip_callback_msg* msg); err_t tcpip_callbackmsg_trycallback(struct tcpip_callback_msg* msg);
/* free pbufs or heap memory from another context without blocking */ /* free pbufs or heap memory from another context without blocking */
err_t pbuf_free_callback(struct pbuf *p); err_t pbuf_free_callback(struct pbuf *p);