/ 
Protocol-OVSDB-v0.99.0
/ Protocol::OVSDB::Lock

NAME

Protocol::OVSDB::Lock - A lock in an Open vSwitch database

SYNOPSIS

use experimental qw( signatures );

my $lock = Protocol::OVSDB::Lock->new(
  id => 'your-lock-name',
  on_update => sub { ... }
);
$ovsdb->lock( $lock, sub($, $error) { die $error if $error } );
$lock->unlock;

$lock->reset;
$ovsdb->steal( $lock, sub($, $error) { die $error if $error } );

DESCRIPTION

This module provides an interface to locks in the OVSDB server. When it goes out of scope, the underlying lock in the OVSDB will be unlocked.

CONSTRUCTORS

new

my $lock = Protocol::OVSDB::Lock->new( %args );

The following arguments are recognized:

  • on_update

    sub on_update( $locked, $reason );

    Callback invoked when the server sends an update notification. The first invocation is the initial response sending the full table content.

reset

$lock->reset;

Resets the lock's state so it can be used as the argument to a lock or steal call again.

unlock

$lock->unlock( sub { ... } );

Releases the lock.

Note The lock is not reusable with an Protocol::OVSDB lock or steal call until the reset method has been called to reset the lock state.

notify

$monitor->notify( $locked, $reason );

Sends an update for $locked to the on_update callback, stating the reason for the update in $reason.

DESTROY

AUTHOR

  • Erik Huelsmann <ehuels@gmail.com>

SEE ALSO

RFC 7047

LICENSE AND COPYRIGHT

See the LICENSE file in this distribution.

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.