.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" 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 "Tangence::Client 3pm" .TH Tangence::Client 3pm "2021-04-30" "perl v5.32.1" "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" "Tangence::Client" \- mixin class for building a "Tangence" client .SH "SYNOPSIS" .IX Header "SYNOPSIS" This class is a mixin, it cannot be directly constructed .PP .Vb 2 \& package Example::Client; \& use base qw( Base::Client Tangence::Client ); \& \& sub connect \& { \& my $self = shift; \& $self\->SUPER::connect( @_ ); \& \& $self\->tangence_connected; \& \& wait_for { defined $self\->rootobj }; \& } \& \& sub tangence_write \& { \& my $self = shift; \& $self\->write( $_[0] ); \& } \& \& sub on_read \& { \& my $self = shift; \& $self\->tangence_readfrom( $_[0] ); \& } \& \& package main; \& \& my $client = Example::Client\->new; \& $client\->connect( "server.location.here" ); \& \& my $rootobj = $client\->rootobj; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module provides mixin to implement a \f(CW\*(C`Tangence\*(C'\fR client connection. It should be mixed in to an object used to represent a single connection to a server. It provides a central location in the client to store object proxies, including to the root object and the registry, and coordinates passing messages between the server and the object proxies it contains. .PP This is a subclass of Tangence::Stream which provides implementations of the required \f(CW\*(C`handle_request_\*(C'\fR methods. A class mixing in \f(CW\*(C`Tangence::Client\*(C'\fR must still provide the \f(CW\*(C`tangence_write\*(C'\fR method required for sending data to the server. .PP For an example of a class that uses this mixin, see Net::Async::Tangence::Client. .SH "PROVIDED METHODS" .IX Header "PROVIDED METHODS" The following methods are provided by this mixin. .SS "rootobj" .IX Subsection "rootobj" .Vb 1 \& $rootobj = $client\->rootobj .Ve .PP Returns a Tangence::ObjectProxy to the server's root object .SS "registry" .IX Subsection "registry" .Vb 1 \& $registry = $client\->registry .Ve .PP Returns a Tangence::ObjectProxy to the server's object registry if one has been received, or \f(CW\*(C`undef\*(C'\fR if not. .PP This method is now deprecated in favour of \*(L"get_registry\*(R". Additionally note that currently the client will attempt to request the registry at connection time, but a later version of this module will stop doing that, so users who need access to it should call \f(CW\*(C`get_registry\*(C'\fR. .SS "get_registry" .IX Subsection "get_registry" .Vb 1 \& $registry = $client\->get_registry\->get .Ve .PP Returns a Future that will yield a Tangence::ObjectProxy to the server's registry object. .PP Note that not all servers may permit access to the registry. .SS "tangence_connected" .IX Subsection "tangence_connected" .Vb 1 \& $client\->tangence_connected( %args ) .Ve .PP Once the base connection to the server has been established, this method should be called to perform the initial work of requesting the root object and the registry. .PP It takes the following named arguments: .IP "do_init => \s-1BOOL\s0" 8 .IX Item "do_init => BOOL" Ignored. Maintained for compatibility with previous version that allowed this to be disabled. .IP "on_root => \s-1CODE\s0" 8 .IX Item "on_root => CODE" Optional callback to be invoked once the root object has been returned. It will be passed a Tangence::ObjectProxy to the root object. .Sp .Vb 1 \& $on_root\->( $rootobj ) .Ve .IP "on_registry => \s-1CODE\s0" 8 .IX Item "on_registry => CODE" Optional callback to be invoked once the registry has been returned. It will be passed a Tangence::ObjectProxy to the registry. .Sp .Vb 1 \& $on_registry\->( $registry ) .Ve .Sp Note that in the case that the server does not permit access to the registry or an error occurs while requesting it, this is invoked with an empty list. .Sp .Vb 1 \& $on_registry\->() .Ve .IP "version_minor_min => \s-1INT\s0" 8 .IX Item "version_minor_min => INT" Optional minimum minor version to negotiate with the server. This can be used to require a higher minimum version than the client module itself supports, in case the application requires features in a newer version than that. .SH "SUBCLASSING METHODS" .IX Header "SUBCLASSING METHODS" These methods are intended for implementation classes to override. .SS "new_future" .IX Subsection "new_future" .Vb 1 \& $f = $client\->new_future .Ve .PP Returns a new Future instance for basing asynchronous operations on. .SH "AUTHOR" .IX Header "AUTHOR" Paul Evans