gray > AnyEvent-MtGox-Stream > AnyEvent::MtGox::Stream

Download:
AnyEvent-MtGox-Stream-0.02.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  1
Stalled  1
View/Report Bugs
Module Version: 0.02   Source  

NAME ^

AnyEvent::MtGox::Stream - AnyEvent client for the MtGox streaming API

SYNOPSIS ^

    use AnyEvent::MtGox::Stream;

    my $client = AnyEvent::MtGox::Stream->new(
        on_message    => sub { },
        on_error      => sub { },
        on_disconnect => sub { },
    );

DESCRIPTION ^

The AnyEvent::MtGox::Stream module is an AnyEvent client for the MtGox streaming API.

METHODS ^

new

    $client = AnyEvent::MtGox::Stream->new(%args)

Creates a new client and returns a guard object if called in non-void context. When it is destroyed, it closes the stream.

The following named arguments are accepted:

secure

Use HTTPS for securing network traffic. (default: 0)

on_message

Callback to execute for each message.

on_error

Callback to execute on error.

on_disconnect

Callback to execute on disconnect.

SEE ALSO ^

AnyEvent

https://en.bitcoin.it/wiki/MtGox/API#Streaming_API

https://github.com/LearnBoost/socket.io-spec

REQUESTS AND BUGS ^

Please report any bugs or feature requests to http://rt.cpan.org/Public/Bug/Report.html?Queue=AnyEvent-MtGox-Stream. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT ^

You can find documentation for this module with the perldoc command.

    perldoc AnyEvent::MtGox::Stream

You can also look for information at:

COPYRIGHT AND LICENSE ^

Copyright (C) 2011 gray <gray at cpan.org>, all rights reserved.

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

AUTHOR ^

gray, <gray at cpan.org>

syntax highlighting: