Cogwheel - A Client/Server Networking Framework based on Moose and Sprocket


Cogwheel documentation Contained in the Cogwheel distribution.

Index


Code Index:

NAME

Top

Cogwheel - A Client/Server Networking Framework based on Moose and Sprocket

VERSION

Top

Version 0.01

SYNOPSIS

Top

    package main;
    use MyApp::Plugin;
    use Cogwheel::Client;
    use Cogwheel::Server;

    my $server = Cogwheel::Server->new(
        Plugins => [
            {
                plugin   => MyApp::Plugin;->new(),
                priority => 0,
            },
        ],
    );

    my $client = Cogwheel::Client->new(
        ClientList => ['localhost:31337'],
        Plugins    => [
            {
                Plugin   => MyApp::Plugin;->new(),
                Priority => 0,
            },
        ],
    );

    POE::Kernel->run();

DESCRIPTION

Top

Cogwheel is a framework for building Network Clients and Servers. It is based off the Sprocket library and Moose.

METHODS

Top

None of the methods in Cogheel itself are truely public, but they are documented here for completeness.

import

Called via use Cogwheel; this will setup the metaclass system properly so that Coghweel objects inherit from Cogwheel::Object. This also enables strict and warnings.

unimport

Unimports any methods exported by import;

meta

Imported from Moose.

DEPENDENCIES

Top

Obviously Moose, and Sprocket

INCOMPATIBILITIES

Top

None reported.

BUGS AND LIMITATIONS

Top

No bugs have been reported.

Please report any bugs or feature requests to bug-cogwheell@rt.cpan.org, or through the web interface at http://rt.cpan.org.

SEE ALSO

Top

Moose, and Sprocket

AUTHOR

Top

Chris Prather <perigrin@cpan.org>

COPYRIGHT AND LICENSE

Top

DISCLAIMER OF WARRANTY

Top

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.


Cogwheel documentation Contained in the Cogwheel distribution.

package Cogwheel;
our $VERSION = 0.03;
use Moose;
use Cogwheel::Object;
use Cogwheel::Types;
{

    sub import {
        my $CALLER = caller();

        strict->import;
        warnings->import;

        # we should never export to main
        return if $CALLER eq 'main';
        Moose::init_meta( $CALLER, 'Cogwheel::Object' );
        Moose->import( { into => $CALLER } );

        # Do my custom framework stuff

        return 1;
    }

    sub unimport {
        goto Moose->can('unimport');
    }
}

no Moose;
1;
__END__