File Coverage

blib/lib/Net/Gnats/Command/LKDB.pm

Criterion	Covered	Total	%
statement	20	20	100.0
branch	2	2	100.0
condition			n/a
subroutine	8	8	100.0
pod	2	3	66.6
total	32	33	96.9

package Net::Gnats::Command::LKDB;
use parent 'Net::Gnats::Command';
use strictures;
BEGIN {
  $Net::Gnats::Command::LKDB::VERSION = '0.20';
}
use vars qw($VERSION);

use Net::Gnats::Constants qw(CODE_OK CODE_CMD_ERROR CODE_GNATS_LOCKED);

=head1 NAME

Net::Gnats::Command::LKDB

=head1 DESCRIPTION

Locks the main gnats database. No subsequent database locks will
succeed until the lock is removed. Sessions that attempt to write to
the database will fail.

=head1 PROTOCOL

 LKDB

=head1 RESPONSES

The possible responses are:

210 (CODE_OK) The lock has been established.

440 (CODE_CMD_ERROR) One or more arguments were supplied to the
command.

431 (CODE_GNATS_LOCKED) The database is already locked, and the lock
could not be obtained after 10 seconds.

6xx (internal error) An internal error occurred, usually because of
permission or other filesystem-related problems. The lock may or may
not have been established.

=cut

my $c = 'LKDB';

sub new {
  my ( $class ) = @_;
  my $self = bless {}, $class;
  return $self;
}

sub as_string {
  return $c;
}

sub is_ok {
  my $self = shift;
  return 1 if $self->response->code == CODE_OK;
  return 0;
}

1;