rippled
Public Member Functions | Private Attributes | List of all members
ripple::JobTypeInfo Class Reference

Holds all the 'static' information about a job, which does not change. More...

Collaboration diagram for ripple::JobTypeInfo:
Collaboration graph
[legend]

Public Member Functions

 JobTypeInfo ()=delete
 
 JobTypeInfo (JobType type, std::string name, int limit, std::chrono::milliseconds avgLatency, std::chrono::milliseconds peakLatency)
 
JobType type () const
 
std::string const & name () const
 
int limit () const
 
bool special () const
 
std::chrono::milliseconds getAverageLatency () const
 
std::chrono::milliseconds getPeakLatency () const
 

Private Attributes

const JobType m_type
 
const std::string m_name
 
const int m_limit
 The limit on the number of running jobs for this job type. More...
 
const std::chrono::milliseconds m_avgLatency
 Average and peak latencies for this job type. More...
 
const std::chrono::milliseconds m_peakLatency
 

Detailed Description

Holds all the 'static' information about a job, which does not change.

Definition at line 28 of file JobTypeInfo.h.

Constructor & Destructor Documentation

◆ JobTypeInfo() [1/2]

ripple::JobTypeInfo::JobTypeInfo ( )
delete

◆ JobTypeInfo() [2/2]

ripple::JobTypeInfo::JobTypeInfo ( JobType  type,
std::string  name,
int  limit,
std::chrono::milliseconds  avgLatency,
std::chrono::milliseconds  peakLatency 
)

Definition at line 49 of file JobTypeInfo.h.

Member Function Documentation

◆ type()

JobType ripple::JobTypeInfo::type ( ) const

Definition at line 64 of file JobTypeInfo.h.

◆ name()

std::string const& ripple::JobTypeInfo::name ( ) const

Definition at line 70 of file JobTypeInfo.h.

◆ limit()

int ripple::JobTypeInfo::limit ( ) const

Definition at line 76 of file JobTypeInfo.h.

◆ special()

bool ripple::JobTypeInfo::special ( ) const

Definition at line 82 of file JobTypeInfo.h.

◆ getAverageLatency()

std::chrono::milliseconds ripple::JobTypeInfo::getAverageLatency ( ) const

Definition at line 88 of file JobTypeInfo.h.

◆ getPeakLatency()

std::chrono::milliseconds ripple::JobTypeInfo::getPeakLatency ( ) const

Definition at line 94 of file JobTypeInfo.h.

Member Data Documentation

◆ m_type

const JobType ripple::JobTypeInfo::m_type
private

Definition at line 31 of file JobTypeInfo.h.

◆ m_name

const std::string ripple::JobTypeInfo::m_name
private

Definition at line 32 of file JobTypeInfo.h.

◆ m_limit

const int ripple::JobTypeInfo::m_limit
private

The limit on the number of running jobs for this job type.

A limit of 0 marks this as a "special job" which is not dispatched via the job queue.

Definition at line 39 of file JobTypeInfo.h.

◆ m_avgLatency

const std::chrono::milliseconds ripple::JobTypeInfo::m_avgLatency
private

Average and peak latencies for this job type.

0 is none specified

Definition at line 42 of file JobTypeInfo.h.

◆ m_peakLatency

const std::chrono::milliseconds ripple::JobTypeInfo::m_peakLatency
private

Definition at line 43 of file JobTypeInfo.h.