Revision 5198dfae src/urt_publisher.c

View differences:

src/urt_publisher.c
48 48 
/**
49 49 
 * @brief   Initalize the publisher.
50 50 
 *
51 
 * @param[in] publisher  Publisher to initalize.
52 
 * @param[in] topic   .
53 
 * @param[in] message   .
51 
 * @param[in] publisher  The publisher to initialize. Must not be NULL.
52 
 * @param[in] topic  The topic, this publisher is associated to. Must not be NULL.
53 
 * @param[in] message  NULL terminated list of messages to contribute to the topic.
54 
 *                     Messages must not be associated to another topic.
55 
 *                     Once a message has been contributed, it cannot be removed later.
56 
 *                     May be NULL (no messages to contribute).
54 57 
 */
55 58 
void urtPublisherInit(urt_publisher_t* publisher, urt_topic_t* topic, urt_message_t* message) {return;}
56 59 

  		




  57
  60
  
    

  		




  58
  61
  
    
/**


  		




  59
  
  
    
 * @brief   Initalize the node.


  		




  
  62
  
    
 * @brief   Publish data.


  		




  60
  63
  
    
 *


  		




  61
  
  
    
 * @param[in] publisher  Publisher to  .


  		




  62
  
  
    
 * @param[in] payload   .


  		




  63
  
  
    
 * @param[in] bytes   .


  		




  64
  
  
    
 * @param[in] t   .


  		




  65
  
  
    
 * @param[in] timeout   .


  		




  
  64
  
    
 * @param[in] publisher  Pointer to the publisher to use. Must not be NULL.


  		




  
  65
  
    
 * @param[in] payload  Pointer to the data to be published. May be NULL for messages without payload.


  		




  
  66
  
    
 * @param[in] bytes  Size of the payload in bytes.


  		




  
  67
  
    
 * @param[in] t  Timestamp to be set for the message.


  		




  
  68
  
    
 * @param[in] timeout  Timeout delay in case the message cannot be published.


  		




  66
  69
  
    
 *


  		




  67
  
  
    
 * @return  A status value.


  		




  
  70
  
    
 * @return  Returns URT_STATUS_OK on success. Returns URT_STATUS_PUBLISH_TIMEOUT on timeout.


  		




  68
  71
  
    
 */


  		




  69
  72
  
    
urt_status_t urtPublisherPublish(urt_publisher_t* publisher, void* payload, size_t bytes, urt_osTime_t t, urt_delay_t timeout) {return URT_STATUS_OK;}


  		












Also available in:  Unified diff