apollo::cyber::croutine::CRoutine类 参考

#include <croutine.h>

apollo::cyber::croutine::CRoutine 的协作图:

Public 成员函数
	CRoutine (const RoutineFunc &func)
virtual	~CRoutine ()
bool	Acquire ()
void	Release ()
void	SetUpdateFlag ()
RoutineState	Resume ()
RoutineState	UpdateState ()
RoutineContext *	GetContext ()
char **	GetStack ()
void	Run ()
void	Stop ()
void	Wake ()
void	HangUp ()
void	Sleep (const Duration &sleep_duration)
RoutineState	state () const
void	set_state (const RoutineState &state)
uint64_t	id () const
void	set_id (uint64_t id)
const std::string &	name () const
void	set_name (const std::string &name)
int	processor_id () const
void	set_processor_id (int processor_id)
uint32_t	priority () const
void	set_priority (uint32_t priority)
std::chrono::steady_clock::time_point	wake_time () const
void	set_group_name (const std::string &group_name)
const std::string &	group_name ()

静态 Public 成员函数
static void	Yield ()
static void	Yield (const RoutineState &state)
static void	SetMainContext (const std::shared_ptr< RoutineContext > &context)
static CRoutine *	GetCurrentRoutine ()
static char **	GetMainStack ()

详细描述

在文件 croutine.h 第 40 行定义.

构造及析构函数说明

CRoutine()

apollo::cyber::croutine::CRoutine::CRoutine ( const RoutineFunc &  func )

explicit

在文件 croutine.cc 第 45 行定义.

                                                  : func_(func) {
  std::call_once(pool_init_flag, [&]() {
    uint32_t routine_num = common::GlobalData::Instance()->ComponentNums();
    auto &global_conf = common::GlobalData::Instance()->Config();
    if (global_conf.has_scheduler_conf() &&
        global_conf.scheduler_conf().has_routine_num()) {
      routine_num =
          std::max(routine_num, global_conf.scheduler_conf().routine_num());
    }
    context_pool.reset(new base::CCObjectPool<RoutineContext>(routine_num));
  });
 
  context_ = context_pool->GetObject();
  if (context_ == nullptr) {
    AWARN << "Maximum routine context number exceeded! Please check "
             "[routine_num] in config file.";
    context_.reset(new RoutineContext());
  }
 
  MakeContext(CRoutineEntry, this, context_.get());
  state_ = RoutineState::READY;
  updated_.test_and_set(std::memory_order_release);
}

~CRoutine()

apollo::cyber::croutine::CRoutine::~CRoutine ( )

virtual

在文件 croutine.cc 第 69 行定义.

{ context_ = nullptr; }

成员函数说明

Acquire()

bool apollo::cyber::croutine::CRoutine::Acquire ( )

inline

在文件 croutine.h 第 197 行定义.

                              {
  return !lock_.test_and_set(std::memory_order_acquire);
}

GetContext()

RoutineContext * apollo::cyber::croutine::CRoutine::GetContext ( )

inline

在文件 croutine.h 第 139 行定义.

{ return context_.get(); }

GetCurrentRoutine()

CRoutine * apollo::cyber::croutine::CRoutine::GetCurrentRoutine ( )

inlinestatic

在文件 croutine.h 第 135 行定义.

{ return current_routine_; }

GetMainStack()

char ** apollo::cyber::croutine::CRoutine::GetMainStack ( )

inlinestatic

在文件 croutine.h 第 137 行定义.

{ return &main_stack_; }

GetStack()

char ** apollo::cyber::croutine::CRoutine::GetStack ( )

inline

在文件 croutine.h 第 141 行定义.

{ return &(context_->sp); }

group_name()

const std::string & apollo::cyber::croutine::CRoutine::group_name ( )

inline

在文件 croutine.h 第 95 行定义.

{ return group_name_; }

HangUp()

void apollo::cyber::croutine::CRoutine::HangUp ( )

inline

在文件 croutine.h 第 155 行定义.

{ CRoutine::Yield(RoutineState::DATA_WAIT); }

id()

uint64_t apollo::cyber::croutine::CRoutine::id ( ) const

inline

在文件 croutine.h 第 162 行定义.

{ return id_; }

name()

const std::string & apollo::cyber::croutine::CRoutine::name ( ) const

inline

在文件 croutine.h 第 166 行定义.

{ return name_; }

priority()

uint32_t apollo::cyber::croutine::CRoutine::priority ( ) const

inline

在文件 croutine.h 第 193 行定义.

{ return priority_; }

processor_id()

int apollo::cyber::croutine::CRoutine::processor_id ( ) const

inline

在文件 croutine.h 第 170 行定义.

{ return processor_id_; }

Release()

void apollo::cyber::croutine::CRoutine::Release ( )

inline

在文件 croutine.h 第 201 行定义.

                              {
  return lock_.clear(std::memory_order_release);
}

Resume()

RoutineState apollo::cyber::croutine::CRoutine::Resume

(

)

在文件 croutine.cc 第 71 行定义.

                              {
  if (cyber_unlikely(force_stop_)) {
    state_ = RoutineState::FINISHED;
    return state_;
  }
 
  if (cyber_unlikely(state_ != RoutineState::READY)) {
    AERROR << "Invalid Routine State!";
    return state_;
  }
 
  current_routine_ = this;
  SwapContext(GetMainStack(), GetStack());
  current_routine_ = nullptr;
  return state_;
}

Run()

void apollo::cyber::croutine::CRoutine::Run ( )

inline

在文件 croutine.h 第 143 行定义.

{ func_(); }

set_group_name()

void apollo::cyber::croutine::CRoutine::set_group_name ( const std::string &  group_name )

inline

在文件 croutine.h 第 91 行定义.

                                                   {
    group_name_ = group_name;
  }

set_id()

void apollo::cyber::croutine::CRoutine::set_id ( uint64_t  id )

inline

在文件 croutine.h 第 164 行定义.

{ id_ = id; }

set_name()

void apollo::cyber::croutine::CRoutine::set_name ( const std::string &  name )

inline

在文件 croutine.h 第 168 行定义.

{ name_ = name; }

set_priority()

void apollo::cyber::croutine::CRoutine::set_priority ( uint32_t  priority )

inline

在文件 croutine.h 第 195 行定义.

{ priority_ = priority; }

set_processor_id()

void apollo::cyber::croutine::CRoutine::set_processor_id ( int  processor_id )

inline

在文件 croutine.h 第 172 行定义.

                                                       {
  processor_id_ = processor_id;
}

set_state()

void apollo::cyber::croutine::CRoutine::set_state ( const RoutineState &  state )

inline

在文件 croutine.h 第 145 行定义.

{ state_ = state; }

SetMainContext()

static void apollo::cyber::croutine::CRoutine::SetMainContext ( const std::shared_ptr< RoutineContext > &  context )

static

SetUpdateFlag()

void apollo::cyber::croutine::CRoutine::SetUpdateFlag ( )

inline

在文件 croutine.h 第 205 行定义.

                                    {
  updated_.clear(std::memory_order_release);
}

Sleep()

void apollo::cyber::croutine::CRoutine::Sleep ( const Duration &  sleep_duration )

inline

在文件 croutine.h 第 157 行定义.

                                                          {
  wake_time_ = std::chrono::steady_clock::now() + sleep_duration;
  CRoutine::Yield(RoutineState::SLEEP);
}

state()

RoutineState apollo::cyber::croutine::CRoutine::state ( ) const

inline

在文件 croutine.h 第 147 行定义.

{ return state_; }

Stop()

void apollo::cyber::croutine::CRoutine::Stop

(

)

在文件 croutine.cc 第 88 行定义.

{ force_stop_ = true; }

UpdateState()

RoutineState apollo::cyber::croutine::CRoutine::UpdateState ( )

inline

在文件 croutine.h 第 176 行定义.

                                          {
  // Synchronous Event Mechanism
  if (state_ == RoutineState::SLEEP &&
      std::chrono::steady_clock::now() > wake_time_) {
    state_ = RoutineState::READY;
    return state_;
  }
 
  // Asynchronous Event Mechanism
  if (!updated_.test_and_set(std::memory_order_release)) {
    if (state_ == RoutineState::DATA_WAIT || state_ == RoutineState::IO_WAIT) {
      state_ = RoutineState::READY;
    }
  }
  return state_;
}

Wake()

void apollo::cyber::croutine::CRoutine::Wake ( )

inline

在文件 croutine.h 第 153 行定义.

{ state_ = RoutineState::READY; }

wake_time()

std::chrono::steady_clock::time_point apollo::cyber::croutine::CRoutine::wake_time ( ) const

inline

在文件 croutine.h 第 149 行定义.

                                                                 {
  return wake_time_;
}

Yield() [1/2]

void apollo::cyber::croutine::CRoutine::Yield ( )

inlinestatic

在文件 croutine.h 第 131 行定义.

                            {
  SwapContext(GetCurrentRoutine()->GetStack(), GetMainStack());
}

Yield() [2/2]

void apollo::cyber::croutine::CRoutine::Yield ( const RoutineState &  state )

inlinestatic

在文件 croutine.h 第 125 行定义.

                                                     {
  auto routine = GetCurrentRoutine();
  routine->set_state(state);
  SwapContext(GetCurrentRoutine()->GetStack(), GetMainStack());
}

---

该类的文档由以下文件生成:

• cyber/croutine/croutine.h
• cyber/croutine/croutine.cc