.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) .\" .\" 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" '' . ds C` . ds C' '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 >0, 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. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" 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 "Net::Async::Tangence::Client 3pm" .TH Net::Async::Tangence::Client 3pm "2022-09-10" "perl v5.34.0" "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" "Net::Async::Tangence::Client" \- connect to a "Tangence" server using "IO::Async" .SH "DESCRIPTION" .IX Header "DESCRIPTION" This subclass of Net::Async::Tangence::Protocol connects to a Tangence server, allowing the client program to access exposed objects in the server. It is a concrete implementation of the \f(CW\*(C`Tangence::Client\*(C'\fR mixin. .PP The following documentation concerns this specific implementation of the client; for more general information on the \f(CW\*(C`Tangence\*(C'\fR\-specific parts of this class, see instead the documentation for Tangence::Client. .SH "PARAMETERS" .IX Header "PARAMETERS" The following named parameters may be passed to \f(CW\*(C`new\*(C'\fR or \f(CW\*(C`configure\*(C'\fR: .IP "identity => \s-1STRING\s0" 8 .IX Item "identity => STRING" The identity string to send to the server. .IP "on_error => \s-1STRING\s0 or \s-1CODE\s0" 8 .IX Item "on_error => STRING or CODE" Default error-handling policy for method calls. If set to either of the strings \f(CW\*(C`carp\*(C'\fR or \f(CW\*(C`croak\*(C'\fR then a \s-1CODE\s0 ref will be created that invokes the given function from \f(CW\*(C`Carp\*(C'\fR; otherwise must be a \s-1CODE\s0 ref. .SH "METHODS" .IX Header "METHODS" The following methods documented with a trailing call to \f(CW\*(C`\->get\*(C'\fR return Future instances. .SS "connect_url" .IX Subsection "connect_url" .Vb 1 \& $rootobj = $client\->connect_url( $url, %args )\->get .Ve .PP Connects to a \f(CW\*(C`Tangence\*(C'\fR server at the given \s-1URL.\s0 The returned Future will yield the root object proxy once it has been obtained. .PP Takes the following named arguments: .IP "on_registry => \s-1CODE\s0" 8 .IX Item "on_registry => CODE" .PD 0 .IP "on_root => \s-1CODE\s0" 8 .IX Item "on_root => CODE" .PD Invoked once the registry and root object proxies have been obtained from the server. See the documentation the Tangence::Client \f(CW\*(C`tangence_connected\*(C'\fR method. .IP "family => \s-1STRING\s0" 8 .IX Item "family => STRING" Optional. May be set to \f(CW\*(C`inet4\*(C'\fR or \f(CW\*(C`inet6\*(C'\fR to force IPv4 or IPv6 if relevant. Ignored by \f(CW\*(C`exec:\*(C'\fR and \f(CW\*(C`unix:\*(C'\fR schemes. .PP The following \s-1URL\s0 schemes are recognised: .IP "\(bu" 4 exec .Sp Directly executes the server as a child process. This is largely provided for testing purposes, as the server will only run for this one client; it will exit when the client disconnects. .Sp .Vb 1 \& exec:///path/to/command?with+arguments .Ve .Sp The \s-1URL\s0's path should point to the required command, and the query string will be split on \f(CW\*(C`+\*(C'\fR signs and used as the arguments. The authority section of the \&\s-1URL\s0 will be ignored, so may be left empty. .IP "\(bu" 4 sshexec .Sp A convenient wrapper around the \f(CW\*(C`exec\*(C'\fR scheme, to connect to a server running remotely via \fIssh\fR. .Sp .Vb 1 \& sshexec://host/path/to/command?with+arguments .Ve .Sp The \s-1URL\s0's authority section will give the \s-1SSH\s0 server (and optionally username), and the path and query sections will be used as for \f(CW\*(C`exec\*(C'\fR. .Sp (This scheme is also available as \f(CW\*(C`ssh\*(C'\fR, though this name is now deprecated) .IP "\(bu" 4 tcp .Sp Connects to a server via a \s-1TCP\s0 socket. .Sp .Vb 1 \& tcp://host:port/ .Ve .Sp The \s-1URL\s0's authority section will be used to give the server's hostname and port number. The other sections of the \s-1URL\s0 will be ignored. .IP "\(bu" 4 unix .Sp Connects to a server via a \s-1UNIX\s0 local socket. .Sp .Vb 1 \& unix:///path/to/socket .Ve .Sp The \s-1URL\s0's path section will give the path to the local socket. The other sections of the \s-1URL\s0 will be ignored. .IP "\(bu" 4 sshunix .Sp Connects to a server running remotely via a \s-1UNIX\s0 socket over \fIssh\fR. .Sp .Vb 1 \& sshunix://host/path/to/socket .Ve .Sp (This is implemented by running \fIperl\fR remotely and sending it a tiny self-contained program that connects \s-1STDIN/STDOUT\s0 to the given \s-1UNIX\s0 socket path. It requires that the server has \fIperl\fR at least version 5.6 available in the path simply as \f(CW\*(C`perl\*(C'\fR) .SH "AUTHOR" .IX Header "AUTHOR" Paul Evans