The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Dancer2::Plugin::ProgressStatus::Object

VERSION

version 0.018

SYNOPSIS

  $progress++;
  $progress->add_message('everything is going swimmingly');

DESCRIPTION

An object that represents a progress status.

METHODS

save

You shouldn't need to call this. Any use of increment, decrement, ++, --, add_message, status, count, etc will automatically call save.

increment

Adds a specified amount to the count (defaults to 1)

  $prog->increment(10);

Can also add messages at the same time

  $prog->increment(10, 'updating count by 10');
decrement

Decrement a specified amount from the count (defaults to 1)

  $prog->decrement(10);

Can also add messages at the same time

  $prog->decrement(10, 'reducing count by 10');
add_message

Adds one or more string messages to the status data.

  $prog->add_message('a simple message');

AUTHOR

Steven Humphrey

COPYRIGHT AND LICENSE

This software is copyright (c) 2015 by Steven Humphrey.

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