Rtos API example

Embed: (wiki syntax)

« Back to documentation index

net_sleep.h File Reference

net_sleep.h File Reference

Checks if there is a sleep possibility for the stack and the max sleep time. More...

Go to the source code of this file.

Functions

uint32_t arm_net_check_enter_deep_sleep_possibility (void)
 Check sleep possibility.
int arm_net_enter_sleep (void)
 Set stack to sleep.
int arm_net_wakeup_and_timer_synch (uint32_t sleeped_time_in_ms)
 Restart stack after sleep.

Detailed Description

Checks if there is a sleep possibility for the stack and the max sleep time.

Checking sleep possibility.

Definition in file net_sleep.h.


Function Documentation

uint32_t arm_net_check_enter_deep_sleep_possibility ( void   )

Check sleep possibility.

Returns:
Time in milliseconds for sleep.
0, No possibility to enter deep sleep.
int arm_net_enter_sleep ( void   )

Set stack to sleep.

Returns:
0 Stack stopped.
-1 Not supported action at the moment.
int arm_net_wakeup_and_timer_synch ( uint32_t  sleeped_time_in_ms )

Restart stack after sleep.

Stack enable and synch timers after sleep.

Parameters:
sleeped_time_in_msThe total sleep time in milliseconds. The stack needs to synch with this.
Returns:
0 Stack restarted.
1 Stack can continue sleep for the time defined in sleeped_time_in_ms.
-1 Stack already active.