Mojo::Transaction - Transaction base class
package Mojo::Transaction::MyTransaction; use Mojo::Base 'Mojo::Transaction'; sub client_read {...} sub client_write {...} sub server_read {...} sub server_write {...}
Mojo::Transaction is an abstract base class for transactions, like Mojo::Transaction::HTTP and Mojo::Transaction::WebSocket.
Mojo::Transaction inherits all events from Mojo::EventEmitter and can emit the following new ones.
$tx->on(connection => sub { my ($tx, $connection) = @_; ... });
Emitted when a connection has been assigned to transaction.
$tx->on(finish => sub { my $tx = shift; ... });
Emitted when transaction is finished.
Mojo::Transaction implements the following attributes.
my $bool = $tx->kept_alive; $tx = $tx->kept_alive($bool);
Connection has been kept alive.
my $address = $tx->local_address; $tx = $tx->local_address('127.0.0.1');
Local interface address.
my $port = $tx->local_port; $tx = $tx->local_port(8080);
Local interface port.
my $address = $tx->original_remote_address; $tx = $tx->original_remote_address('127.0.0.1');
Remote interface address.
my $port = $tx->remote_port; $tx = $tx->remote_port(8081);
Remote interface port.
my $req = $tx->req; $tx = $tx->req(Mojo::Message::Request->new);
HTTP request, defaults to a Mojo::Message::Request object.
my $res = $tx->res; $tx = $tx->res(Mojo::Message::Response->new);
HTTP response, defaults to a Mojo::Message::Response object.
Mojo::Transaction inherits all methods from Mojo::EventEmitter and implements the following new ones.
$tx->client_close;
Transaction closed client-side, used to implement user agents such as Mojo::UserAgent.
$tx->client_read($bytes);
Read data client-side, used to implement user agents such as Mojo::UserAgent. Meant to be overloaded in a subclass.
my $bytes = $tx->client_write;
Write data client-side, used to implement user agents such as Mojo::UserAgent. Meant to be overloaded in a subclass.
$tx = $tx->completed;
Finalize transaction.
my $id = $tx->connection; $tx = $tx->connection($id);
Connection identifier.
my $err = $tx->error;
Get request or response error and return undef if there is no error, commonly used together with "success".
undef
# Longer version my $err = $tx->req->error || $tx->res->error; # Check for different kinds of errors if (my $err = $tx->error) { die "$err->{code} response: $err->{message}" if $err->{code}; die "Connection error: $err->{message}"; }
my $bool = $tx->is_finished;
Check if transaction is finished.
my $bool = $tx->is_websocket;
False, this is not a Mojo::Transaction::WebSocket object.
my $address = $tx->remote_address; $tx = $tx->remote_address('127.0.0.1');
Same as "original_remote_address" or the last value of the X-Forwarded-For header if "req" has been performed through a reverse proxy.
X-Forwarded-For
$tx->server_close;
Transaction closed server-side, used to implement web servers such as Mojo::Server::Daemon.
$tx->server_read($bytes);
Read data server-side, used to implement web servers such as Mojo::Server::Daemon. Meant to be overloaded in a subclass.
my $bytes = $tx->server_write;
Write data server-side, used to implement web servers such as Mojo::Server::Daemon. Meant to be overloaded in a subclass.
my $res = $tx->success;
Returns the Mojo::Message::Response object from "res" if transaction was successful or undef otherwise. Connection and parser errors have only a message in "error", 400 and 500 responses also a code.
400
500
# Sensible exception handling if (my $res = $tx->success) { say $res->body } else { my $err = $tx->error; die "$err->{code} response: $err->{message}" if $err->{code}; die "Connection error: $err->{message}"; }
Mojolicious, Mojolicious::Guides, http://mojolicious.org.
To install Mojolicious, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Mojolicious
CPAN shell
perl -MCPAN -e shell install Mojolicious
For more information on module installation, please visit the detailed CPAN module installation guide.