File SolidSyslogLwipRawMarshal.h¶

FileList > Interface > SolidSyslogLwipRawMarshal.h

The marshal seam that pins the library's lwIP Raw API calls to the core-owning thread. More...

#include "ExternC.h"

Public Types¶

Type	Name
typedef void(*	SolidSyslogLwipRawMarshalFunction Runs callback(context) on the lwIP core thread; must return only after it has completed (see the file overview).

Public Attributes¶

Type	Name
EXTERN_C_BEGIN typedef void(*	SolidSyslogLwipRawCallback The work the marshal must run on the core-owning thread.

Public Functions¶

Type	Name
void	SolidSyslogLwipRaw_SetMarshal (SolidSyslogLwipRawMarshalFunction marshal) Installs the process-global marshal.

Detailed Description¶

Every lwIP call the Datagram and TcpStream adapters make is routed through a single marshal hop so an integrator can run those calls on the thread that owns the lwIP core. (The numeric Resolver's ipaddr_aton parse touches no core state and is intentionally not marshalled.)

NO_SYS=1 (bare metal, no RTOS): the default direct-call marshal is correct — one execution context, no core to protect.
NO_SYS=0 (RTOS with a tcpip thread): the integrator installs a marshal that hops onto that thread — e.g. tcpip_callback_with_block, or a LOCK_TCPIP_CORE / UNLOCK_TCPIP_CORE pair.

The marshal MUST invoke its callback synchronously, before it returns: the wrapper reads results the callback writes immediately after the hop, so an asynchronous marshal is caller error. tcpip_callback_with_block(.., block=1) honours this; a bare tcpip_callback(..) does not. See docs/integrating-lwip.md.

Public Types Documentation¶

typedef SolidSyslogLwipRawMarshalFunction¶

Runs callback(context) on the lwIP core thread; must return only after it has completed (see the file overview).

typedef void(* SolidSyslogLwipRawMarshalFunction) (SolidSyslogLwipRawCallback callback, void *context);

Public Attributes Documentation¶

variable SolidSyslogLwipRawCallback¶

The work the marshal must run on the core-owning thread.

EXTERN_C_BEGIN typedef void(* SolidSyslogLwipRawCallback) (void *context);

Public Functions Documentation¶

function SolidSyslogLwipRaw_SetMarshal¶

Installs the process-global marshal.

void SolidSyslogLwipRaw_SetMarshal (
    SolidSyslogLwipRawMarshalFunction marshal
)

One lwIP instance and one tcpip thread per process means a single global slot suffices — same shape as SolidSyslog_SetErrorHandler. NULL restores the direct-call default. Intended for setup-time configuration; not synchronised with concurrent installs.

The documentation for this class was generated from the following file Platform/LwipRaw/Interface/SolidSyslogLwipRawMarshal.h