Struct veloren_server::persistence::character_updater::CharacterUpdater

pub struct CharacterUpdater {
    update_tx: Option<Sender<CharacterUpdaterAction>>,
    response_rx: Receiver<CharacterUpdaterMessage>,
    handle: Option<JoinHandle<()>>,
    pending_database_actions: HashMap<CharacterId, DatabaseAction>,
    disconnect_all_clients_requested: Arc<AtomicBool>,
    last_pending_database_event_id: u64,
}

A unidirectional messaging resource for saving characters in a background thread.

This is used to make updates to a character and their persisted components, such as inventory, loadout, etc…

Fields

update_tx: Option<Sender<CharacterUpdaterAction>>

response_rx: Receiver<CharacterUpdaterMessage>

handle: Option<JoinHandle<()>>

pending_database_actions: HashMap<CharacterId, DatabaseAction>

Pending actions to be performed during the next persistence batch, such as updates for recently logged out players and character deletions

disconnect_all_clients_requested: Arc<AtomicBool>

Will disconnect all characters (without persistence) on the next tick if set to true

last_pending_database_event_id: u64

Implementations

impl CharacterUpdater

pub fn new(settings: Arc<RwLock<DatabaseSettings>>) -> Result<Self>

pub fn add_pending_logout_update(&mut self, update_data: CharacterUpdateData)

Adds a character to the list of characters that have recently logged out and will be persisted in the next batch update.

pub fn has_pending_database_action(&self, character_id: CharacterId) -> bool

pub fn process_batch_completion(&mut self, completed_batch_id: u64)

pub fn disconnect_all_clients_requested(&self) -> bool

Returns a value indicating whether there is a pending request to disconnect all clients due to a batch update transaction failure

pub fn create_character( &mut self, entity: Entity, requesting_player_uuid: String, alias: String, persisted_components: PersistedComponents )

pub fn edit_character( &mut self, entity: Entity, requesting_player_uuid: String, character_id: CharacterId, alias: String, editable_components: EditableComponents )

fn next_pending_database_event_id(&mut self) -> u64

pub fn queue_character_deletion( &mut self, requesting_player_uuid: String, character_id: CharacterId )

pub fn batch_update( &mut self, updates: impl Iterator<Item = CharacterUpdateData> )

Updates a collection of characters based on their id and components

pub fn disconnected_success(&mut self)

Indicates to the batch update thread that a requested disconnection of all clients has been processed

pub fn messages(&self) -> TryIter<'_, CharacterUpdaterMessage>

Returns a non-blocking iterator over CharacterLoaderResponse messages

Trait Implementations

impl Drop for CharacterUpdater

fn drop(&mut self)

Executes the destructor for this type.