#include "lwip/opt.h"
#include "lwip/tcpip.h"
#include "lwip/sys.h"
#include "lwip/timeouts.h"

Include dependency graph for tcpip_priv.h:

This graph shows which files directly or indirectly include this file:

Classes
struct	tcpip_api_call_data

struct	tcpip_msg

Macros
#define	API_VAR_REF(name) name

#define	API_VAR_DECLARE(type, name) type name

#define	API_VAR_ALLOC_EXT(type, pool, name, errorblock)

#define	API_VAR_ALLOC(type, pool, name, errorval)

#define	API_VAR_ALLOC_POOL(type, pool, name, errorval)

#define	API_VAR_FREE(pool, name)

#define	API_VAR_FREE_POOL(pool, name)

#define	API_EXPR_REF(expr) expr

#define	API_EXPR_REF_SEM(expr) API_EXPR_REF(expr)

#define	API_EXPR_DEREF(expr) (*(expr))

#define	API_MSG_M_DEF(m) *m

#define	API_MSG_M_DEF_C(t, m) const t * m

Typedefs
typedef err_t(*	tcpip_api_call_fn) (struct tcpip_api_call_data *call)

Enumerations
enum	tcpip_msg_type { TCPIP_MSG_API , TCPIP_MSG_API_CALL , TCPIP_MSG_INPKT , TCPIP_MSG_CALLBACK , TCPIP_MSG_CALLBACK_STATIC , TCPIP_MSG_CALLBACK_STATIC_WAIT }

Functions
err_t	tcpip_send_msg_wait_sem (tcpip_callback_fn fn, void apimsg, sys_sem_t sem)

err_t	tcpip_api_call (tcpip_api_call_fn fn, struct tcpip_api_call_data *call)

Detailed Description

TCPIP API internal implementations (do not use in application code)

Definition in file tcpip_priv.h.

Macro Definition Documentation

◆ API_EXPR_DEREF

#define API_EXPR_DEREF ( expr ) (*(expr))

Definition at line 92 of file tcpip_priv.h.

◆ API_EXPR_REF

#define API_EXPR_REF ( expr ) expr

Definition at line 90 of file tcpip_priv.h.

◆ API_EXPR_REF_SEM

#define API_EXPR_REF_SEM ( expr ) API_EXPR_REF(expr)

Definition at line 91 of file tcpip_priv.h.

◆ API_MSG_M_DEF

#define API_MSG_M_DEF ( m ) *m

Definition at line 93 of file tcpip_priv.h.

◆ API_MSG_M_DEF_C

#define API_MSG_M_DEF_C	(	t,
		m
	)	const t * m

Definition at line 94 of file tcpip_priv.h.

◆ API_VAR_ALLOC

#define API_VAR_ALLOC	(	type,
		pool,
		name,
		errorval
	)

Definition at line 86 of file tcpip_priv.h.

◆ API_VAR_ALLOC_EXT

#define API_VAR_ALLOC_EXT	(	type,
		pool,
		name,
		errorblock
	)

Definition at line 85 of file tcpip_priv.h.

◆ API_VAR_ALLOC_POOL

#define API_VAR_ALLOC_POOL	(	type,
		pool,
		name,
		errorval
	)

Definition at line 87 of file tcpip_priv.h.

◆ API_VAR_DECLARE

#define API_VAR_DECLARE	(	type,
		name
	)	type name

Definition at line 84 of file tcpip_priv.h.

◆ API_VAR_FREE

#define API_VAR_FREE	(	pool,
		name
	)

Definition at line 88 of file tcpip_priv.h.

◆ API_VAR_FREE_POOL

#define API_VAR_FREE_POOL	(	pool,
		name
	)

Definition at line 89 of file tcpip_priv.h.

◆ API_VAR_REF

#define API_VAR_REF ( name ) name

Definition at line 83 of file tcpip_priv.h.

Typedef Documentation

◆ tcpip_api_call_fn

typedef err_t(* tcpip_api_call_fn) (struct tcpip_api_call_data *call)

Definition at line 110 of file tcpip_priv.h.

Enumeration Type Documentation

◆ tcpip_msg_type

enum tcpip_msg_type

Enumerator
TCPIP_MSG_API
TCPIP_MSG_API_CALL
TCPIP_MSG_INPKT
TCPIP_MSG_CALLBACK
TCPIP_MSG_CALLBACK_STATIC
TCPIP_MSG_CALLBACK_STATIC_WAIT

Definition at line 113 of file tcpip_priv.h.

                    {
#if !LWIP_TCPIP_CORE_LOCKING
  TCPIP_MSG_API,
  TCPIP_MSG_API_CALL,
#endif /* !LWIP_TCPIP_CORE_LOCKING */
#if !LWIP_TCPIP_CORE_LOCKING_INPUT
  TCPIP_MSG_INPKT,
#endif /* !LWIP_TCPIP_CORE_LOCKING_INPUT */
#if LWIP_TCPIP_TIMEOUT && LWIP_TIMERS
  TCPIP_MSG_TIMEOUT,
  TCPIP_MSG_UNTIMEOUT,
#endif /* LWIP_TCPIP_TIMEOUT && LWIP_TIMERS */
  TCPIP_MSG_CALLBACK,
  TCPIP_MSG_CALLBACK_STATIC,
  TCPIP_MSG_CALLBACK_STATIC_WAIT
};

Function Documentation

◆ tcpip_api_call()

err_t tcpip_api_call	(	tcpip_api_call_fn	fn,
		struct tcpip_api_call_data *	call
	)

Synchronously calls function in TCPIP thread and waits for its completion. It is recommended to use LWIP_TCPIP_CORE_LOCKING (preferred) or LWIP_NETCONN_SEM_PER_THREAD. If not, a semaphore is created and destroyed on every call which is usually an expensive/slow operation.

Parameters

fn	Function to call
call	Call parameters

Returns: Return value from tcpip_api_call_fn

Definition at line 478 of file tcpip.c.

{
#if LWIP_TCPIP_CORE_LOCKING
  err_t err;
  LOCK_TCPIP_CORE();
  err = fn(call);
  UNLOCK_TCPIP_CORE();
  return err;
#else /* LWIP_TCPIP_CORE_LOCKING */
  TCPIP_MSG_VAR_DECLARE(msg);
 
#if !LWIP_NETCONN_SEM_PER_THREAD
  err_t err = sys_sem_new(&call->sem, 0);
  if (err != ERR_OK) {
    return err;
  }
#endif /* LWIP_NETCONN_SEM_PER_THREAD */
 
  LWIP_ASSERT("Invalid mbox", sys_mbox_valid_val(tcpip_mbox));
 
  TCPIP_MSG_VAR_ALLOC(msg);
  TCPIP_MSG_VAR_REF(msg).type = TCPIP_MSG_API_CALL;
  TCPIP_MSG_VAR_REF(msg).msg.api_call.arg = call;
  TCPIP_MSG_VAR_REF(msg).msg.api_call.function = fn;
#if LWIP_NETCONN_SEM_PER_THREAD
  TCPIP_MSG_VAR_REF(msg).msg.api_call.sem = LWIP_NETCONN_THREAD_SEM_GET();
#else /* LWIP_NETCONN_SEM_PER_THREAD */
  TCPIP_MSG_VAR_REF(msg).msg.api_call.sem = &call->sem;
#endif /* LWIP_NETCONN_SEM_PER_THREAD */
  sys_mbox_post(&tcpip_mbox, &TCPIP_MSG_VAR_REF(msg));
  sys_arch_sem_wait(TCPIP_MSG_VAR_REF(msg).msg.api_call.sem, 0);
  TCPIP_MSG_VAR_FREE(msg);
 
#if !LWIP_NETCONN_SEM_PER_THREAD
  sys_sem_free(&call->sem);
#endif /* LWIP_NETCONN_SEM_PER_THREAD */
 
  return call->err;
#endif /* LWIP_TCPIP_CORE_LOCKING */
}

◆ tcpip_send_msg_wait_sem()

err_t tcpip_send_msg_wait_sem	(	tcpip_callback_fn	fn,
		void *	apimsg,
		sys_sem_t *	sem
	)

Sends a message to TCPIP thread to call a function. Caller thread blocks on on a provided semaphore, which ist NOT automatically signalled by TCPIP thread, this has to be done by the user. It is recommended to use LWIP_TCPIP_CORE_LOCKING since this is the way with least runtime overhead.