1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
package Dancer2::Core::Response::Delayed;
# ABSTRACT: Delayed responses
$Dancer2::Core::Response::Delayed::VERSION = '1.1.0';
use Moo;
use Dancer2::Core::Types qw<CodeRef InstanceOf>;
has request => (
is => 'ro',
isa => InstanceOf['Dancer2::Core::Request'],
required => 1,
);
has response => (
is => 'ro',
isa => InstanceOf['Dancer2::Core::Response'],
required => 1,
handles => [qw/status headers push_header/],
);
has cb => (
is => 'ro',
isa => CodeRef,
required => 1,
);
has error_cb => (
is => 'ro',
isa => CodeRef,
predicate => '_has_error_cb',
);
sub is_halted() {0}
sub has_passed() {0}
sub to_psgi {
my $self = shift;
return sub {
my $responder = shift;
local $Dancer2::Core::Route::REQUEST = $self->request;
local $Dancer2::Core::Route::RESPONSE = $self->response;
local $Dancer2::Core::Route::RESPONDER = $responder;
local $Dancer2::Core::Route::WRITER;
local $Dancer2::Core::Route::ERROR_HANDLER =
$self->_has_error_cb ? $self->error_cb : undef;
$self->cb->();
};
}
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
Dancer2::Core::Response::Delayed - Delayed responses
=head1 VERSION
version 1.1.0
=head1 SYNOPSIS
my $response = Dancer2::Core::Response::Delayed->new(
request => Dancer2::Core::Request->new(...),
response => Dancer2::Core::Response->new(...),
cb => sub {...},
# optional error handling
error_cb => sub {
my ($error) = @_;
...
},
);
# or in an app
get '/' => sub {
# delayed response:
delayed {
# streaming content
content "data";
content "more data";
# close user connection
done;
} on_error => sub {
my ($error) = @_;
warning 'Failed to stream to user: ' . request->remote_address;
};
};
=head1 DESCRIPTION
This object represents a delayed (asynchronous) response for L<Dancer2>.
It can be used via the C<delayed> keyword.
It keeps references to a request and a response in order to avoid
keeping a reference to the application.
=head1 ATTRIBUTES
=head2 request
Contains a request the delayed response uses.
In the context of a web request, this will be the request that existed
when the delayed response has been created.
=head2 response
Contains a response the delayed response uses.
In the context of a web request, this will be the response that existed
when the delayed response has been created.
=head2 cb
The code that will be run asynchronously.
=head2 error_cb
A callback for handling errors. This callback receives the error as its
first (and currently only) parameter.
=head1 METHODS
=head2 is_halted
A method indicating whether the response has halted.
This is useless in the context of an asynchronous request so it simply
returns no.
This method is likely going away.
=head2 has_passed
A method indicating whether the response asked to skip the current
response.
This is useless in the context of an asynchronous request so it simply
returns no.
This method is likely going away.
=head2 to_psgi
Create a PSGI response. The way it works is by returning a proper PSGI
response subroutine which localizes the request and response (in case
the callback wants to edit them without a reference to them), and then
calls the callback.
Finally, when the callback is done, it asks the response (whether it
was changed or not) to create its own PSGI response (calling C<to_psgi>)
and sends that to the callback it receives as a delayed response.
=head1 AUTHOR
Dancer Core Developers
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2023 by Alexis Sukrieh.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
|
