APR::UUID - Perl API for manipulating APR UUIDs


mod_perl documentation  | view source Contained in the mod_perl distribution.

Index


NAME

Top

APR::UUID - Perl API for manipulating APR UUIDs

Synopsis

Top

  use APR::UUID ();

  # get a random UUID and format it as a string
  my $uuid = APR::UUID->new->format;
  # $uuid = e.g. 'd48889bb-d11d-b211-8567-ec81968c93c6';

  # same as the object returned by APR::UUID->new
  my $uuid_parsed = APR::UUID->parse($uuid);




Description

Top

APR::UUID is used to get and manipulate random UUIDs.

It allows you to create random UUIDs, which when formatted returns a string like:

  'd48889bb-d11d-b211-8567-ec81968c93c6';

which can be parsed back into the APR::UUID object with parse().

API

Top

APR::UUID provides the following functions and/or methods:

format

Convert an APR::UUID object (docs::2.0::api::APR::UUID) object into a string presentation:

  my $uuid_str = $uuid->format;

obj: $uuid ( APR::UUID object (docs::2.0::api::APR::UUID) )
ret: $uuid_str

returns a string representation of the object (.e.g 'd48889bb-d11d-b211-8567-ec81968c93c6').

since: 2.0.00

new

Create a APR::UUID object (docs::2.0::api::APR::UUID) using the random engine:

  my $uuid = APR::UUID->new;

class: APR::UUID ( APR::UUID class (docs::2.0::api::APR::UUID) )
ret: $uuid ( APR::UUID object (docs::2.0::api::APR::UUID) )
since: 2.0.00

DESTROY

  $uuid->DESTROY;

obj: APR::UUID ( APR::UUID object (docs::2.0::api::APR::UUID) )
ret: no return value
since: 2.0.00

Do not call this method, it's designed to be only called by Perl when the variable goes out of scope. If you call it yourself you will get a segfault when perl will call DESTROY on its own.

parse

Convert a UUID string into an APR::UUID object (docs::2.0::api::APR::UUID) object:

  $uuid = APR::UUID->parse($uuid_str)

arg1: $uuid_str (string)

UUID string (.e.g 'd48889bb-d11d-b211-8567-ec81968c93c6')

ret: $uuid ( APR::UUID object (docs::2.0::api::APR::UUID) )

The new object.

since: 2.0.00

See Also

Top

mod_perl 2.0 documentation (docs::2.0::index).

Copyright

Top

Authors

Top

The mod_perl development team and numerous contributors (about::contributors::people).


mod_perl documentation  | view source Contained in the mod_perl distribution.