https://github.com/grinnz/mojo-promise-role-get

Mojo::Promise::Role::Get - Wait for the results of a Mojo::Promise
https://github.com/grinnz/mojo-promise-role-get

Last synced: 5 days ago
JSON representation

Mojo::Promise::Role::Get - Wait for the results of a Mojo::Promise

• Host: GitHub
• URL: https://github.com/grinnz/mojo-promise-role-get
• Owner: Grinnz
• License: other
• Created: 2018-10-04T18:48:34.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2021-06-16T04:12:51.000Z (over 3 years ago)
• Last Synced: 2024-11-13T05:34:35.506Z (about 2 months ago)
• Language: Perl
• Homepage: https://metacpan.org/pod/Mojo::Promise::Role::Get
• Size: 24.4 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.pod
  • Changelog: Changes
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
=pod

=head1 NAME

Mojo::Promise::Role::Get - Wait for the results of a Mojo::Promise

=head1 SYNOPSIS

  use Mojo::IOLoop;

  use Mojo::Promise;

  use Mojo::UserAgent;

  my $ua = Mojo::UserAgent->new;

  # long way of writing $ua->get('http://example.com')->result

  my $res = $ua->get_p('http://example.com')->with_roles('+Get')->get->result;

  # wait for multiple requests at once

  my @responses = map { $_->[0]->result } Mojo::Promise->all(

    $ua->get_p('http://example.com'),

    $ua->get_p('https://www.google.com'),

  )->with_roles('Mojo::Promise::Role::Get')->get;

  # request with exception on timeout

  my $timeout = Mojo::Promise->new;

  Mojo::IOLoop->timer(1 => sub { $timeout->reject('Timed out!') });

  my $res = Mojo::Promise->race($ua->get_p('http://example.com'), $timeout)

    ->with_roles('Mojo::Promise::Role::Get')->get->result;

=head1 DESCRIPTION

L is a L L that adds

a L"get"> method to facilitate the usage of asynchronous code in a

synchronous manner, similar to L.

Note: Like in Future, L"get"> cannot retrieve results when the event loop is

already running, as that can recurse into the event reactor. Unlike in Future,

this is true even if the promise has already been resolved or rejected, because

retrieving L results always requires running the event loop.

=head1 METHODS

L composes the following methods.

=head2 get

  my @results = $promise->get;

  my $first_result = $promise->get;

Blocks until the promise resolves or is rejected. If it is fulfilled, the

results are returned. In scalar context the first value is returned. If the

promise is rejected, the (first value of the) rejection reason is thrown as an

exception.

An exception is thrown if the L is running, to prevent

recursing into the event reactor.

=head1 BUGS

Report any issues on the public bugtracker.

=head1 AUTHOR

Dan Book 

=head1 COPYRIGHT AND LICENSE

This software is Copyright (c) 2018 by Dan Book.

This is free software, licensed under:

  The Artistic License 2.0 (GPL Compatible)

=head1 SEE ALSO

L

=cut