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

Download:
Clustericious-Client-0.85.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.85   Source  

NAME ^

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

VERSION ^

version 0.85

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

Get documentation for a route.

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

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: Curt Tilmes

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

contributors:

Brian Duggan

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: