Donatien Garnier / rtos_net_beta

Semaphore.h@0:e6ccf0b3d718, 2012-05-31 (annotated)

Committer:
donatien
Date:
Thu May 31 15:46:30 2012 +0000
Revision:
0:e6ccf0b3d718

        

        
Who changed what in which revision?

        

            
                
UserRevisionLine numberNew contents of line

            
            


donatien

0:e6ccf0b3d718


     1

/* Copyright (c) 2012 mbed.org */





donatien

0:e6ccf0b3d718


     2

#ifndef SEMAPHORE_H





donatien

0:e6ccf0b3d718


     3

#define SEMAPHORE_H 





donatien

0:e6ccf0b3d718


     4







donatien

0:e6ccf0b3d718


     5

#include <stdint.h>





donatien

0:e6ccf0b3d718


     6

#include "cmsis_os.h"





donatien

0:e6ccf0b3d718


     7







donatien

0:e6ccf0b3d718


     8

namespace rtos {





donatien

0:e6ccf0b3d718


     9







donatien

0:e6ccf0b3d718


    10

/*! The Semaphore class is used to manage and protect access to a set of shared resources. */





donatien

0:e6ccf0b3d718


    11

class Semaphore {





donatien

0:e6ccf0b3d718


    12

public:





donatien

0:e6ccf0b3d718


    13

    /*! Create and Initialize a Semaphore object used for managing resources. 





donatien

0:e6ccf0b3d718


    14

      \param number of available resources; maximum index value is (count-1).





donatien

0:e6ccf0b3d718


    15

    */





donatien

0:e6ccf0b3d718


    16

    Semaphore(int32_t count);





donatien

0:e6ccf0b3d718


    17

    





donatien

0:e6ccf0b3d718


    18

    /*! Wait until a Semaphore resource becomes available. 





donatien

0:e6ccf0b3d718


    19

      \param   millisec  timeout value or 0 in case of no time-out. (default: osWaitForever).





donatien

0:e6ccf0b3d718


    20

      \return  number of available tokens, or -1 in case of incorrect parameters





donatien

0:e6ccf0b3d718


    21

    */





donatien

0:e6ccf0b3d718


    22

    int32_t wait(uint32_t millisec=osWaitForever);





donatien

0:e6ccf0b3d718


    23

    





donatien

0:e6ccf0b3d718


    24

    /*! Release a Semaphore resource that was obtain with Semaphore::wait.





donatien

0:e6ccf0b3d718


    25

      \return  status code that indicates the execution status of the function. 





donatien

0:e6ccf0b3d718


    26

    */





donatien

0:e6ccf0b3d718


    27

    osStatus release(void);





donatien

0:e6ccf0b3d718


    28







donatien

0:e6ccf0b3d718


    29

private:





donatien

0:e6ccf0b3d718


    30

    osSemaphoreId _osSemaphoreId;





donatien

0:e6ccf0b3d718


    31

    osSemaphoreDef_t _osSemaphoreDef;





donatien

0:e6ccf0b3d718


    32

#ifdef CMSIS_OS_RTX





donatien

0:e6ccf0b3d718


    33

    uint32_t _semaphore_data[2];





donatien

0:e6ccf0b3d718


    34

#endif





donatien

0:e6ccf0b3d718


    35

};





donatien

0:e6ccf0b3d718


    36







donatien

0:e6ccf0b3d718


    37

}





donatien

0:e6ccf0b3d718


    38

#endif