Lines Matching full:observer

31 	/** Static channel observer list start index. Considering the ITERABLE SECTIONS allocation
36 	/** Static channel observer list end index. Considering the ITERABLE SECTIONS allocation
47 	/** Channel observer list. Represents the channel's observers list, it can be empty
89  * @brief Type used to represent an observer type.
91  * A observer can be a listener or a subscriber.
100  * @brief Type used to represent an observer.
102  * Every observer has an representation structure containing the relevant information.
103  * An observer is a code portion interested in some channel. The observer can be notified
105  * The observer can be enabled or disabled during runtime by change the enabled boolean
111  * @see zbus_obs_set_enable function to properly change the observer's enabled field.
116 	/** Observer name. */
122 	/** Enabled flag. Indicates if observer is receiving notification. */
126 		/** Observer message queue. It turns the observer into a subscriber. */
129 		/** Observer callback function. It turns the observer into a listener. */
133 		/** Observer message FIFO. It turns the observer into a message subscriber. It only
234  * channel and the observer.
237  * @param _obs Observer instance.
239  * @param _prio Observer notification sequence priority.
252  * channel and the observer.
255  * @param _obs Observer instance.
256  * @param _prio Observer notification sequence priority.
282  * This macro indicates the channel has listed observers. Note the sequence of observer notification
298  * @param _observers The observers list. The sequence indicates the priority of the observer. The
334  * This macro defines an observer of subscriber type. It defines a message queue where the
352  * This macro defines an observer of subscriber type. It defines a message queue where the
366  * This macro defines an observer of listener type. This macro establishes the callback where the
382  * This macro defines an observer of listener type. This macro establishes the callback where the
394  * This macro defines an observer of @ref ZBUS_OBSERVER_SUBSCRIBER_TYPE type. It defines a FIFO
413  * This macro defines an observer of message subscriber type. It defines a FIFO where the
440  * observer, or the function context is invalid (inside an ISR). The function only returns this
520  * observer, or the function context is invalid (inside an ISR). The function only returns this
620  * @brief Add an observer to a channel.
622  * This routine adds an observer to the channel.
625  * @param obs The observer's reference to be added.
626  * @param timeout Waiting period to add an observer,
629  * @retval 0 Observer added to the channel.
630  * @retval -EALREADY The observer is already present in the channel's runtime observers list.
639  * @brief Remove an observer from a channel.
641  * This routine removes an observer to the channel.
644  * @param obs The observer's reference to be removed.
645  * @param timeout Waiting period to remove an observer,
648  * @retval 0 Observer removed to the channel.
652  * @retval -ENODATA no observer found in channel's runtime observer list.
670  * @brief Change the observer state.
672  * This routine changes the observer state. A channel when disabled will not receive
675  * @param[in] obs The observer's reference.
676  * @param[in] enabled State to be. When false the observer stops to receive notifications.
678  * @retval 0 Observer set enable.
692  * @brief Get the observer state.
694  * This routine retrieves the observer state.
696  * @param[in] obs The observer's reference.
699  * @return Observer state.
712  * @brief Mask notifications from a channel to an observer.
714  * The observer can mask notifications from a specific observing channel by calling this function.
716  * @param obs The observer's reference to be added.
718  * @param masked The mask state. When the mask is true, the observer will not receive notifications
721  * @retval 0 Channel notifications masked to the observer.
729  * @brief Get the notifications masking state from a channel to an observer.
731  * @param obs The observer's reference to be added.
733  * @param[out] masked The mask state. When the mask is true, the observer will not receive
746  * @brief Get the observer's name.
748  * This routine returns the observer's name reference.
750  * @param obs The observer's reference.
752  * @return The observer's name reference.
777  * @retval -EINVAL The observer is not a subscriber.
798  * @retval -EINVAL The observer is not a subscriber.
845  * iterator_func which is called for each observer. If the iterator_func returns false all
859  * iterator_func which is called for each observer. If the iterator_func returns false all