User`s guide

KwikNet Low Level Services

DAK

179

kn_yield kn_yield

Purpose Yield to the KwikNet Task

Used by

n Task o ISP o Timer Procedure o Restart Procedure o Exit Procedure

Setup Prototype is in file KN_API.H.

#include "KN_LIB.H"

int kn_yield(void);

Description Your single threaded application must regularly yield to the KwikNet Task.

Failure to yield at least at the defined KwikNet clock frequency may result

in poor performance of the TCP/IP stack.

Returns Error status is returned.

The value 1 is returned if the KwikNet Task executes successfully.

The value 0 is returned if the request to execute the KwikNet Task fails.

The return value of 0 indicates that the KwikNet Task cannot be executed

for some reason. For example, if an application UDP callback function

calls kn_yield() when it is executed by the KwikNet Task, the call will

fail because the KwikNet Task cannot execute recursively.

Restriction Must only be called in a single threaded system by the App-Task while

executing in the user domain.