view release on metacpan or  search on metacpan

lib/Ceph/Rados.pm  view on Meta::CPAN

# Bring in the whole lot of C constants that are available. Your mileage
# of course, may vary, e.g. alternatively do this via @EXPORT_OK.
our @EXPORT = (
    # any other symbols you are exporting, plus:
    $_symbols_present ? @Ceph::Rados::Constants::C::Symbols::ALL
        : (),
);

# Preloaded methods go here.

sub new {
    my ($class, $id, %args) = @_;
    my $obj = create($id);
    bless $obj, $class;

    while( my ($key, $value) = each %args ) {
        my $method = "set_${key}";
        if( $obj->can($method) ) {
            $obj->$method($value);
        } else {
            Carp::carp "Invalid setting '$key'";
        }
    }
    return $obj;
}

sub io {
    my ($self, $pool_name) = @_;
    croak "usage: ->io(pool_name)" unless defined $pool_name;
    Ceph::Rados::IO->new($self, $pool_name);
}

sub DESTROY {
    my $self = shift;
    $self->shutdown if ${^GLOBAL_PHASE} eq 'DESTRUCT';
}

# Autoload methods go after =cut, and are processed by the autosplit program.

1;
__END__
# Below is stub documentation for your module. You'd better edit it!

=head1 NAME

Ceph::Rados - Perl wrapper to librados.

=head1 SYNOPSIS

  use Ceph::Rados;

  my $cluster = Ceph::Rados->new('admin');
  $cluster->set_config_file;
  $cluster->set_config_option( keyring => '/etc/ceph/ceph.client.admin.keyring');
  $cluster->connect;

  my $io = $cluster->io('testing_pool');
  $io->write('greeting', 'hello');
  my $stored_data = $io->read('greeting',10);
  my ($len, $mtime) = $io->stat('greeting');
  $io->delete('greeting');

  my $list = $io->list;
  while (my $entry = $list->next) {
      print "Found $entry\n";
  }

=head1 DESCRIPTION

This module provides a very limited subset of the librados API,
currently just read/write/stat and lists.

If no length is passed to the read() call, the object is first stat'd
to determine the correct read length.

=head1 METHODS

=head2 set_config_file()

Wraps C<rados_conf_read_file()>.  If not passed a path, the following locations are tried, in order:

=over 4

=item C<$ENV{CEPH_CONF}>

=item /etc/ceph/ceph.conf

=item ~/.ceph/config

=item ./ceph.conf

=back

=head2 set_config_option()

Wraps C<rados_conf_set()>.  Typically used to set the keyring.

=head2 connect()

Wraps C<rados_connect()>.  Connects to the rados cluster, using the config provided.

=head2 io()

Wraps C<rados_ioctx_create()>.  Opens an IO context to the specified pool.
Returns a L<Ceph::Rados::IO> object.

=head1 SEE ALSO

librados documentation - L<http://docs.ceph.com/docs/master/rados/api/librados/>

=head1 AUTHOR

Alex Bowley, E<lt>alex@openimp.comE<gt>

=head1 COPYRIGHT AND LICENSE

Copyright (C) 2014-2017 by Alex Bowley.

This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.14.2 or,