Seastar
High performance C++ framework for concurrent servers
Classes | Public Member Functions | Static Public Member Functions | List of all members
seastar::io_priority_class Class Reference

Public Member Functions

io_priority_class_id id () const noexcept
 
future update_shares (uint32_t shares) const
 Updates the current amount of shares for a given priority class. More...
 
future update_bandwidth (uint64_t bandwidth) const
 Updates the current bandwidth for a given priority class. More...
 
future rename (sstring new_name) noexcept
 
unsigned get_shares () const
 
sstring get_name () const
 

Static Public Member Functions

static io_priority_class register_one (sstring name, uint32_t shares)
 

Member Function Documentation

◆ rename()

future seastar::io_priority_class::rename ( sstring  new_name)
noexcept

Renames an io priority class

Renames an io_priority_class previously created with register_one_priority_class().

The operation is global and affects all shards. The operation affects the exported statistics labels.

Parameters
pcThe io priority class to be renamed
new_nameThe new name for the io priority class
Returns
a future that is ready when the io priority class have been renamed

◆ update_bandwidth()

future seastar::io_priority_class::update_bandwidth ( uint64_t  bandwidth) const

Updates the current bandwidth for a given priority class.

The bandwidth applied is NOT shard-local, instead it is applied so that all shards cannot consume more bytes-per-second altogether

Parameters
bandwidththe new bandwidth value in bytes/second
Returns
a future that is ready when the bandwidth update is applied

◆ update_shares()

future seastar::io_priority_class::update_shares ( uint32_t  shares) const

Updates the current amount of shares for a given priority class.

Parameters
pcthe priority class handle
sharesthe new shares value
Returns
a future that is ready when the share update is applied

The documentation for this class was generated from the following file: