NAME

Ubic::Result::Class - ubic result object

VERSION

version 1.29

SYNOPSIS

    use Ubic::Result qw(result);

    my $result = result("already running");
    print $result->status; # running
    print "$result"; # already running

DESCRIPTION

Ubic::Result::Class instances represent service operation results.

Many service actions can *do* something and *result* in something. So, this class dissects service operation into action() and status(). For example, "already running" result means that current service status is "running" and action is "none".

Also, it carry custom comment and serialize result into common stringified form.

Ubic::Result::Class instances are usually created via result() function from Ubic::Result package.

STATUSES

Possible statuses:

running

not running

broken

down

ACTIONS

Actions are something that was done which resulted in current status by invoked method.

Possible actions:

started

stopped

none

reloaded

METHODS

new({ type => $type, msg => $msg })

Constructor.

status()

Get status, see above for possible values.

action()

Get action.

as_string()

Get string representation.

SEE ALSO

Ubic::Result - service action's result.

AUTHOR

Vyacheslav Matyukhin <mmcleric@yandex-team.ru>

COPYRIGHT AND LICENSE

This software is copyright (c) 2011 by Yandex LLC.

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