Brian Duggan > Clustericious-Client-0.66 > Clustericious::Client::Meta

Download:
Clustericious-Client-0.66.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Source   Latest Release: Clustericious-Client-0.85

NAME ^

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

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.

syntax highlighting: