Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Dancer2::Core::ResponsUsereContributed PerlDancer2::Core::Response::Delayed(3)

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

VERSION
       version 0.300004

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

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.

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.

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.

AUTHOR
       Dancer Core Developers

COPYRIGHT AND LICENSE
       This software is	copyright (c) 2020 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.

perl v5.32.1			  2020-05-2Dancer2::Core::Response::Delayed(3)

NAME | VERSION | SYNOPSIS | DESCRIPTION | ATTRIBUTES | METHODS | AUTHOR | COPYRIGHT AND LICENSE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Dancer2::Core::Response::Delayed&sektion=3&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help