GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  UBIC::SERVICE::SKELETON (3)

.ds Aq ’

NAME

Ubic::Service::Skeleton - skeleton of any service with common start/stop logic

CONTENTS

VERSION

version 1.58

ACTIONS

<B>B>status()<B>B> Get status of service.

Possible values: running, not running, unknown, broken.

<B>B>start()<B>B> Start service.

Throws exception on failure.

<B>B>stop()<B>B> Stop service.

Return values: stopped, not running.

Throws exception on failure.

OVERLOADABLE METHODS

Subclass must overload following methods with simple status, start and stop implementations.
<B>status_implB> Status implementation. Should return result object or plain string which coerces to result object.
<B>start_implB> Start implementation.

It can check for status itself and return proper Ubic::Result value, or it can allow skeleton class to recheck status after that, in several attempts.

To choose second option, it should return non-result value or result("starting"). See timeout_options() method for details about recheck policy.

<B>stop_implB> Stop implementation.

It can check for status itself and return proper Ubic::Result value, or it can allow skeleton class to recheck status after that, in several attempts.

To choose second option, it should return non-result value or result("stopping"). See timeout_options() method for details about recheck policy.

<B>timeout_optionsB> Return hashref with timeout options.

Possible options:
start Params to be used when checking for status of started service.

Should contain hashref with step and trials options for wait_for_status function from Ubic::Service::Utils.

AUTHOR

Vyacheslav Matyukhin <mmcleric@yandex-team.ru>

COPYRIGHT AND LICENSE

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

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 UBIC::SERVICE::SKELETON (3) 2015-01-27

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.