rippled
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
xrpl::JobTypeInfo Class Reference

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

#include <JobTypeInfo.h>

Collaboration diagram for xrpl::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

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

Detailed Description

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

Definition at line 9 of file JobTypeInfo.h.

Constructor & Destructor Documentation

◆ JobTypeInfo() [1/2]

xrpl::JobTypeInfo::JobTypeInfo ( )
delete

◆ JobTypeInfo() [2/2]

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

Definition at line 30 of file JobTypeInfo.h.

Member Function Documentation

◆ type()

JobType xrpl::JobTypeInfo::type ( ) const

Definition at line 45 of file JobTypeInfo.h.

◆ name()

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

Definition at line 51 of file JobTypeInfo.h.

◆ limit()

int xrpl::JobTypeInfo::limit ( ) const

Definition at line 57 of file JobTypeInfo.h.

◆ special()

bool xrpl::JobTypeInfo::special ( ) const

Definition at line 63 of file JobTypeInfo.h.

◆ getAverageLatency()

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

Definition at line 69 of file JobTypeInfo.h.

◆ getPeakLatency()

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

Definition at line 75 of file JobTypeInfo.h.

Member Data Documentation

◆ m_type

JobType const xrpl::JobTypeInfo::m_type
private

Definition at line 12 of file JobTypeInfo.h.

◆ m_name

std::string const xrpl::JobTypeInfo::m_name
private

Definition at line 13 of file JobTypeInfo.h.

◆ m_limit

int const xrpl::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 20 of file JobTypeInfo.h.

◆ m_avgLatency

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

Average and peak latencies for this job type.

0 is none specified

Definition at line 23 of file JobTypeInfo.h.

◆ m_peakLatency

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

Definition at line 24 of file JobTypeInfo.h.