/ 
XAS-0.05
River stage one • 6 direct dependents • 6 total dependents
/ XAS::Lib::Gearman::Admin

NAME

XAS::Lib::Gearman::Admin - An interface to the Gearman job queue.

SYNOPSIS

use XAS:::Lib::Gearman::Admin;

my $client = XAS::Lib::Gearman::Admin->new(
    -server => 'localhost',
    -port   => '4730'
);

DESCRIPTION

This module is a wrapper around the Gearman Admin protocol. If unifies common methods with error handling to make main line code easier to work with.

METHODS

new

This method initializes the module, it doesn't make a connection to the gearman server. It takes two parameters:

-server

The server that gearman is running on, defaults to 'localhost'.

-port

The IP port that geraman is listening on, defaults to 4730.

connect

Connect to gearman.

disconnet

Disconnect from gearman.

shutdown

Tell gearman to shutdown. It takes one optional parameter:

-graceful

Do the shutdown gracefully.

ping

Send a "ping" to gearman. This will tell if the server is functioning.

set_maxqueue

Set the maximum number of workers for a queue. It takes two parameters:

-queue

The name of the queue.

-size

The number of workers.

get_version

Returns the current version of the gearman server.

get_status

Retrieves the current status of queues on gearman. Depending on context, it can return an array or a reference to an array of XAS::Lib::Gearman::Admin::Status objects. It takes one optional parameter:

-queue

The name of the queue for the status request.

get_workers

This method returns the workers attached to gearman. Depending on context, it can return an array or a reference to an array of XAS::Lib::Gearmam::Admin:::Worker objects. It takes one optional parameter:

-queue

The name of the queue for the worker request.

SEE ALSO

Gearman::XS
Gearman::XS::Client
Gearman::XS::Worker
XAS

AUTHOR

Kevin L. Esteb, <kevin@kesteb.us>

COPYRIGHT AND LICENSE

Copyright (C) 2011 by Kevin L. Esteb

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.8 or, at your option, any later version of Perl 5 you may have available.