Graham Ollis π > Clustericious-1.21 > Clustericious::Client::Meta

Download:
Clustericious-1.21.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 1.21   Source  

NAME ^

Clustericious::Client::Meta - simple meta object for constructing clients

VERSION ^

version 1.21

METHODS ^

add_route

Add or replace documentation about a route.

Parameters :

the name of the client class
the name of the route
documentation about the route's arguments

get_route_doc

 $meta->get_route_doc($class,$route_name);

Get documentation for a route.

add_route_attribute

Add an attribute for a route.

Parameters :

the name of the attribute
the value of the attribute.

Recognized attributes :

dont_read_files : if set, no attempt will be made to treat arguments as yaml files.
auto_failover : if set, when a connection fails and does not return a status code, each url in the list of configured failover_url's will be tried in turn.

get_route_attribute

Like the above but retrieve an attribute.

add_object

Add an object.

Parameters :

the name of the client class
the name of the object
documentation about the object.

routes, objects

Return an array ref of routes/objects.

Each element is a two element array; the first element is the name, the second is documentation.

SEE ALSO ^

Clustericious::Client, Clustericious

AUTHOR ^

Original author: Brian Duggan

Current maintainer: Graham Ollis <plicease@cpan.org>

Contributors:

Curt Tilmes

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2013 by NASA GSFC.

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

syntax highlighting: