Trait AdvisoryLockingServerHandler

pub trait AdvisoryLockingServerHandler<___T: Transport> {
    // Required method
    fn advisory_lock(
        &mut self,
        sender: &ServerSender<___T, AdvisoryLocking>,
        request: RequestBuffer<___T, AdvisoryLock>,
        responder: Responder<AdvisoryLock>,
    );
}

A server handler for the AdvisoryLocking protocol.

See AdvisoryLocking for more details.

Required Methods

fn advisory_lock( &mut self, sender: &ServerSender<___T, AdvisoryLocking>, request: RequestBuffer<___T, AdvisoryLock>, responder: Responder<AdvisoryLock>, )

Acquires an advisory lock on the underlying file.

The lock lasts until either this connection is closed or this method is called with |AdvisoryLockType.UNLOCK| to release the lock explicitly.

Advisory locks are purely advisory. They do not prevent actual read or write operations from occurring on the file, either through this connection or through other connections.

This method requires the following rights:

• [Rights.READ_BYTES] if request.type is [AdvisoryLockType.READ].
• [Rights.WRITE_BYTES] if request.type is [AdvisoryLockType.WRITE].

Errors

• ZX_ERR_BAD_STATE The specified type of lock cannot be acquired. For example, another connection might hold a conflicting lock type.
• ZX_ERR_NOT_SUPPORTED This file does not support advisory locking.
• ZX_ERR_ACCESS_DENIED This connection does not have sufficient rights to acquire the given type of lock.

Implementors