NAME

Ubic::Result - common return value for many ubic interfaces

VERSION

version 1.60

SYNOPSIS

use Ubic::Result qw(:all);

sub start {
    ...
    return result('broken', 'permission denied');

    # or:
    return result('running');

    # or:
    return 'already running'; # will be automagically wrapped into result object by Ubic.pm
}

FUNCTIONS

result($type, $optional_message)

Construct Ubic::Result::Class instance.

POSSIBLE RESULT TYPES

This is a full list of results which can be recognized by Ubic::Result::Class.

Any other result will be interpreted as unknown.

running
not running
already running
started
already started
restarted
reloaded
stopping
not running
stopped
down
starting
broken

SEE ALSO

Ubic::Result::Class - result instance.

AUTHOR

Vyacheslav Matyukhin <mmcleric@yandex-team.ru>

COPYRIGHT AND LICENSE

This software is copyright (c) 2016 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.