logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

Dancer2::Core::Response::Delayed - Delayed responses

Attributes

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.

   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.

   cb
       The code that will be run asynchronously.

   error_cb
       A callback for handling errors. This callback receives the error as its first (and currently only)
       parameter.

Author

       Dancer Core Developers

Description

       This object represents a delayed (asynchronous) response for Dancer2.  It can be used via the "delayed"
       keyword.

       It keeps references to a request and a response in order to avoid keeping a reference to the application.

Methods

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.

   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.

   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 "to_psgi") and sends that to the callback it receives as a delayed response.

Name

       Dancer2::Core::Response::Delayed - Delayed responses

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;
               };
           };

Version

       version 1.1.2

See Also