SAM function SAM-Worker-fb-policy-set()

From SoOS

Jump to: navigation, search


[edit] Name

SAM_Worker_fb_policy_set - Set the flash back policy

[edit] Synopsis

#include <sam.h>
SAM_Worker_fb_policy_t SAM_Worker_fb_policy_set(SAM_t sam, SAM_Workerid_t wid, SAM_Worker_fb_policy_t policy);

[edit] Description

The SAM_Worker_fb_policy_set() function changes the flash back policy of the worker wid with the value of policy.

Related constants:

    The same as SAM_FBPOLICY_RETRY.
    The worker thread is restarted automatically after the flash back after the flash back retry delay.
    The worker thread is halted until it is manually restarted after a flash back.

[edit] Return value

The value returned is the previous flash back policy.

[edit] Errors

None, assumes correct input parameters.

[edit] Examples


[edit] See also

SAM_Worker_fb_policy_get(), <sam.h>.