.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Mojo::IOLoop::Client 3pm" .TH Mojo::IOLoop::Client 3pm "2013-02-19" "perl v5.14.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Mojo::IOLoop::Client \- Non\-blocking TCP client .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Mojo::IOLoop::Client; \& \& # Create socket connection \& my $client = Mojo::IOLoop::Client\->new; \& $client\->on(connect => sub { \& my ($client, $handle) = @_; \& ... \& }); \& $client\->on(error => sub { \& my ($client, $err) = @_; \& ... \& }); \& $client\->connect(address => \*(Aqmojolicio.us\*(Aq, port => 80); \& \& # Start reactor if necessary \& $client\->reactor\->start unless $client\->reactor\->is_running; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Mojo::IOLoop::Client opens \s-1TCP\s0 connections for Mojo::IOLoop. .SH "EVENTS" .IX Header "EVENTS" Mojo::IOLoop::Client inherits all events from Mojo::EventEmitter and can emit the following new ones. .SS "connect" .IX Subsection "connect" .Vb 4 \& $client\->on(connect => sub { \& my ($client, $handle) = @_; \& ... \& }); .Ve .PP Emitted safely once the connection is established. .SS "error" .IX Subsection "error" .Vb 4 \& $client\->on(error => sub { \& my ($client, $err) = @_; \& ... \& }); .Ve .PP Emitted safely if an error occurs on the connection. .SH "ATTRIBUTES" .IX Header "ATTRIBUTES" Mojo::IOLoop::Client implements the following attributes. .SS "reactor" .IX Subsection "reactor" .Vb 2 \& my $reactor = $client\->reactor; \& $client = $client\->reactor(Mojo::Reactor::Poll\->new); .Ve .PP Low level event reactor, defaults to the \f(CW\*(C`reactor\*(C'\fR attribute value of the global Mojo::IOLoop singleton. .SH "METHODS" .IX Header "METHODS" Mojo::IOLoop::Client inherits all methods from Mojo::EventEmitter and implements the following new ones. .SS "connect" .IX Subsection "connect" .Vb 1 \& $client\->connect(address => \*(Aq127.0.0.1\*(Aq, port => 3000); .Ve .PP Open a socket connection to a remote host. Note that \s-1TLS\s0 support depends on IO::Socket::SSL (1.75+) and IPv6 support on IO::Socket::IP (0.16+). .PP These options are currently available: .IP "address" 2 .IX Item "address" Address or host name of the peer to connect to, defaults to \f(CW\*(C`localhost\*(C'\fR. .IP "handle" 2 .IX Item "handle" Use an already prepared handle. .IP "local_address" 2 .IX Item "local_address" Local address to bind to. .IP "port" 2 .IX Item "port" Port to connect to. .IP "timeout" 2 .IX Item "timeout" Maximum amount of time in seconds establishing connection may take before getting canceled, defaults to \f(CW10\fR. .IP "tls" 2 .IX Item "tls" Enable \s-1TLS\s0. .IP "tls_ca" 2 .IX Item "tls_ca" Path to \s-1TLS\s0 certificate authority file. Also activates hostname verification. .IP "tls_cert" 2 .IX Item "tls_cert" Path to the \s-1TLS\s0 certificate file. .IP "tls_key" 2 .IX Item "tls_key" Path to the \s-1TLS\s0 key file. .SH "SEE ALSO" .IX Header "SEE ALSO" Mojolicious, Mojolicious::Guides, .