Revision 5198dfae src/urt_service.c

View differences:

src/urt_service.c
48 48 
/**
49 49 
 * @brief   Initalize the service.
50 50 
 *
51 
 * @param[in] service  Service to intialize.
52 
 * @param[in] id   .
53 
 * @param[in] callback   .
51 
 * @param[in] service  The service to initialize. Must not be NULL.
52 
 * @param[in] id  Unique, numeric identifier of the service.
53 
 * @param[in] callback  Callback function to be executed by this service. Must not be NULL.
54 54 
 *
55 
 * @return  A status value.
55 
 * @return  Returns URT_STATUS_OK on success.
56 
 *          Returns URT_STATUS_SERVICE_DUPLICATE if another service with the same identifier already exists.
56 57 
 */
57 58 
urt_status_t urtServiceInit(urt_service_t* service, urt_serviceid_t id, urt_servicefunc_t* callback) {return URT_STATUS_OK;}
58 59 

  		




  59
  60
  
    
/**


  		




  60
  
  
    
 * @brief   Call the Service .


  		




  
  61
  
    
 * @brief   Calls a service.


  		




  61
  62
  
    
 *


  		




  62
  
  
    
 * @param[in] service  Service to  .


  		




  63
  
  
    
 * @param[in] arg   .


  		




  64
  
  
    
 * @param[in] ret   .


  		




  65
  
  
    
 * @param[in] timeout   .


  		




  
  63
  
    
 * @param[in] service  The service to call. Must not be NULL.


  		




  
  64
  
    
 * @param[in] arg  Optional argument for the service call. May be NULL if the service expects no arguments.


  		




  
  65
  
    
 * @param[in] ret  Pointer to an optional output value. May be NULL.


  		




  
  66
  
    
 * @param[in] timeout  Timeout delay to be propagated to the callback function.


  		




  
  67
  
    
 *                     Whether timeout is considered depends on the callback function.


  		




  66
  68
  
    
 *


  		




  67
  
  
    
 * @return  A status value.


  		




  
  69
  
    
 * @return  Returns the exact output status of the service call.


  		




  68
  70
  
    
 */


  		




  69
  71
  
    
urt_status_t urtServiceCall(urt_service_t* service, void* arg, void* ret, urt_delay_t timeout) {return URT_STATUS_OK;}


  		












Also available in:  Unified diff