Agora C++ API Reference for All Platforms
Public Member Functions | List of all members
agora::rtc::StateNotifier< STATE_TYPE, REASON_TYPE > Class Template Reference

Public Member Functions

 StateNotifier (STATE_TYPE init_value)
 
 ~StateNotifier ()
 
void Notify (uint64_t ts, STATE_TYPE state, REASON_TYPE reason)
 
StateEvents< STATE_TYPE, REASON_TYPE > GetEvents (bool readOnly=false)
 
bool PopEvent (STATE_TYPE state, StateEvent< STATE_TYPE, REASON_TYPE > &retEvent)
 
STATE_TYPE CurrentState ()
 

Constructor & Destructor Documentation

◆ StateNotifier()

template<typename STATE_TYPE , typename REASON_TYPE >
agora::rtc::StateNotifier< STATE_TYPE, REASON_TYPE >::StateNotifier ( STATE_TYPE  init_value)
inlineexplicit

◆ ~StateNotifier()

template<typename STATE_TYPE , typename REASON_TYPE >
agora::rtc::StateNotifier< STATE_TYPE, REASON_TYPE >::~StateNotifier ( )
inline

Member Function Documentation

◆ Notify()

template<typename STATE_TYPE , typename REASON_TYPE >
void agora::rtc::StateNotifier< STATE_TYPE, REASON_TYPE >::Notify ( uint64_t  ts,
STATE_TYPE  state,
REASON_TYPE  reason 
)
inline

◆ GetEvents()

template<typename STATE_TYPE , typename REASON_TYPE >
StateEvents<STATE_TYPE, REASON_TYPE> agora::rtc::StateNotifier< STATE_TYPE, REASON_TYPE >::GetEvents ( bool  readOnly = false)
inline

◆ PopEvent()

template<typename STATE_TYPE , typename REASON_TYPE >
bool agora::rtc::StateNotifier< STATE_TYPE, REASON_TYPE >::PopEvent ( STATE_TYPE  state,
StateEvent< STATE_TYPE, REASON_TYPE > &  retEvent 
)
inline

◆ CurrentState()

template<typename STATE_TYPE , typename REASON_TYPE >
STATE_TYPE agora::rtc::StateNotifier< STATE_TYPE, REASON_TYPE >::CurrentState ( )
inline