File Coverage

blib/lib/Data/ID/Maildir.pm

Criterion	Covered	Total	%
statement	24	24	100.0
branch	2	2	100.0
condition	1	3	33.3
subroutine	7	7	100.0
pod	1	1	100.0
total	35	37	94.5

=head1 NAME

Data::ID::Maildir - generate maildir-style unique IDs

=head1 SYNOPSIS

    use Data::ID::Maildir qw(maildir_id);

    $id = maildir_id;

=head1 DESCRIPTION

This module exports one function, C, which generates
maildir-style unique IDs.

=cut

package Data::ID::Maildir;

{ use 5.006; }
use warnings;
use strict;

use Sys::Hostname qw(hostname);
use Time::HiRes 1.00 qw(gettimeofday);

our $VERSION = "0.005";

use parent "Exporter";
our @EXPORT_OK = qw(maildir_id);

=head1 FUNCTIONS

=over

=item maildir_id

=item maildir_id(HOSTNAME)

Generates a maildir-style unique ID.  The ID is based on the time,
process ID, and hostname; it is guaranteed to be unique among IDs
generated by this algorithm provided the hostname is unique among hosts
using this algorithm.  The hostname may be specified to the function if
it is necessary to override it.

=cut

sub maildir_id(;$) {
	my($hostname) = @_;
	$hostname = hostname unless defined $hostname;
	my($sec, $usec) = gettimeofday;
	my($new_sec, $new_usec);
	do {
		($new_sec, $new_usec) = gettimeofday;
	} while($new_sec == $sec && $new_usec == $usec);
	$sec.".M".$usec."P".$$.".".$hostname;
}

=back

=head1 BUGS

Can theoretically generate duplicate message IDs during a leap second.

=head1 SEE ALSO

L,
L,
L,
L

=head1 AUTHOR

Andrew Main (Zefram)

=head1 COPYRIGHT

Copyright (C) 2004, 2007, 2010, 2011, 2017
Andrew Main (Zefram)

=head1 LICENSE

This module is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.

=cut

1;