summaryrefslogtreecommitdiff
path: root/lib/Travel
diff options
context:
space:
mode:
authorDaniel Friesel <derf@finalrewind.org>2022-01-30 17:28:38 +0100
committerDaniel Friesel <derf@finalrewind.org>2022-01-30 17:28:38 +0100
commit086e9d2e9cc4ec743248fb08ddeed688dc8a9129 (patch)
tree753b37e82fad518cfd75d0375d28822cc1c0bc6f /lib/Travel
parente89ed392bb06abf8cc36d31b3b033ef2b2abf57b (diff)
Document new_p
Diffstat (limited to 'lib/Travel')
-rw-r--r--lib/Travel/Status/DE/IRIS.pm57
1 files changed, 57 insertions, 0 deletions
diff --git a/lib/Travel/Status/DE/IRIS.pm b/lib/Travel/Status/DE/IRIS.pm
index 79e96d9..7bd180b 100644
--- a/lib/Travel/Status/DE/IRIS.pm
+++ b/lib/Travel/Status/DE/IRIS.pm
@@ -928,6 +928,8 @@ Travel::Status::DE::IRIS - Interface to IRIS based web departure monitors.
=head1 SYNOPSIS
+Blocking variant:
+
use Travel::Status::DE::IRIS;
use Travel::Status::DE::IRIS::Stations;
@@ -943,6 +945,30 @@ Travel::Status::DE::IRIS - Interface to IRIS based web departure monitors.
);
}
+Non-blocking variant:
+
+ use Mojo::Promise;
+ use Mojo::UserAgent;
+ use Travel::Status::DE::IRIS;
+ use Travel::Status::DE::IRIS::Stations;
+
+ # Get station code for "Essen Hbf" (-> "EE")
+ my $station = (Travel::Status::DE::IRIS::Stations::get_station_by_name(
+ 'Essen Hbf'))[0][0];
+
+ Travel::Status::DE::IRIS->new_p(station => $station,
+ promise => 'Mojo::Promise', user_agent => Mojo::UserAgent->new,
+ get_station => \&Travel::Status::DE::IRIS::Stations::get_station,
+ meta => Travel::Status::DE::IRIS::Stations::get_meta())->then(sub {
+ my ($status) = @_;
+ for my $r ($status->results) {
+ printf(
+ "%s %s +%-3d %10s -> %s\n",
+ $r->date, $r->time, $r->delay || 0, $r->line, $r->destination
+ );
+ }
+ })->wait;
+
=head1 VERSION
version 1.63
@@ -1055,6 +1081,37 @@ departures for all related stations.
=back
+=item my $promise = Travel::Status::DE::IRIS->new_p(I<%opt>)
+
+Return a promise yielding a Travel::Status::DE::IRIS instance (C<< $status >>)
+on success, or an error message (same as C<< $status->errstr >>) on failure.
+
+In addition to the arguments of B<new>, the following mandatory arguments must
+be set:
+
+=over
+
+=item B<promise> => I<promises module>
+
+Promises implementation to use for internal promises as well as B<new_p> return
+value. Recommended: Mojo::Promise(3pm).
+
+=item B<get_station> => I<get_station ref>
+
+Reference to Travel::Status::DE::IRIS::Stations::get_station().
+
+=item B<meta> => I<meta dict>
+
+The dictionary returned by Travel::Status::DE::IRIS::Stations::get_meta().
+
+=item B<user_agent> => I<user agent>
+
+User agent instance to use for asynchronous requests. The object must support
+promises (i.e., it must implement a C<< get_p >> function). Recommended:
+Mojo::UserAgent(3pm).
+
+=back
+
=item $status->errstr
In case of a fatal HTTP request or IRIS error, returns a string describing it.