include/ecrt.h
changeset 886 ee1b25db1fbf
parent 880 f6212c54a5e3
child 893 d921fff3d6e2
equal deleted inserted replaced
885:eaa10a277d52 886:ee1b25db1fbf
   647  */
   647  */
   648 uint8_t *ecrt_domain_data(
   648 uint8_t *ecrt_domain_data(
   649         ec_domain_t *domain /**< Domain. */
   649         ec_domain_t *domain /**< Domain. */
   650         );
   650         );
   651 
   651 
   652 /** Processes received datagrams.
   652 /** Determines the states of the domain's datagrams.
   653  *
   653  *
   654  * \todo doc
   654  * Evaluates the working counters of the received datagrams and outputs
       
   655  * statistics, if necessary. This must be called after ecrt_master_receive()
       
   656  * is expected to receive the domain datagrams in order to make
       
   657  * ecrt_domain_state() return the result of the last process data exchange.
   655  */
   658  */
   656 void ecrt_domain_process(
   659 void ecrt_domain_process(
   657         ec_domain_t *domain /**< Domain. */
   660         ec_domain_t *domain /**< Domain. */
   658         );
   661         );
   659 
   662 
   660 /** (Re-)queues all domain datagrams in the master's datagram queue.
   663 /** (Re-)queues all domain datagrams in the master's datagram queue.
   661  *
   664  *
   662  * \todo doc
   665  * Call this function to mark the domain's datagrams for exchanging at the
       
   666  * next call of ecrt_master_send().
   663  */
   667  */
   664 void ecrt_domain_queue(
   668 void ecrt_domain_queue(
   665         ec_domain_t *domain /**< Domain. */
   669         ec_domain_t *domain /**< Domain. */
   666         );
   670         );
   667 
   671 
   668 /** Reads the state of a domain.
   672 /** Reads the state of a domain.
   669  *
   673  *
   670  * Stores the domain state in the giveb \a state structure.
   674  * Stores the domain state in the given \a state structure.
   671  */
   675  */
   672 void ecrt_domain_state(
   676 void ecrt_domain_state(
   673         const ec_domain_t *domain, /**< Domain. */
   677         const ec_domain_t *domain, /**< Domain. */
   674         ec_domain_state_t *state /**< Pointer to a state object to store the
   678         ec_domain_state_t *state /**< Pointer to a state object to store the
   675                                    information. */
   679                                    information. */