.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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
.\" ========================================================================
.\"
.IX Title "IKC::Client 3"
.TH IKC::Client 3 2024-09-01 "perl v5.40.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
POE::Component::IKC::Client \- POE Inter\-Kernel Communication client
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 10
\&    use POE;
\&    use POE::Component::IKC::Client;
\&    POE::Component::IKC::Client\->spawn(
\&        ip=>$ip, 
\&        port=>$port,
\&        name=>"Client$$",
\&        subscribe=>[qw(poe:/*/timserver)]
\&    );
\&    ...
\&    $poe_kernel\->run();
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module implements an POE IKC client.  An IKC client attempts to connect
to a IKC server.  If successful, it negociates certain connection
parameters.  After this, the POE server and client are pretty much
identical.
.SH "EXPORTED FUNCTIONS"
.IX Header "EXPORTED FUNCTIONS"
.SS create_ikc_client
.IX Subsection "create_ikc_client"
Syntatic sugar for POE::Component::IKC::Client\->spawn.
.SH "CLASS METHODS"
.IX Header "CLASS METHODS"
.SS spawn
.IX Subsection "spawn"
This methods initiates all the work of connecting to an IKC server.
Parameters are :
.ie n .IP """ip""" 4
.el .IP \f(CWip\fR 4
.IX Item "ip"
Address to connect to.  Can be a doted-quad ('127.0.0.1') or a host name
('foo.pied.nu').  Defaults to '127.0.0.1', aka INADDR_LOOPBACK.
.ie n .IP """port""" 4
.el .IP \f(CWport\fR 4
.IX Item "port"
Port to connect to.  Can be numeric (80) or a service ('http').
.ie n .IP """unix""" 4
.el .IP \f(CWunix\fR 4
.IX Item "unix"
Path to unix-domain socket that the server is listening on.
.ie n .IP """name""" 4
.el .IP \f(CWname\fR 4
.IX Item "name"
Local kernel name.  This is how we shall "advertise" ourself to foreign
kernels. It acts as a "kernel alias".  This parameter is temporary, pending
the addition of true kernel names in the POE core.  This name, and all
aliases will be registered with the responder so that you can post to them
as if they were remote.
.ie n .IP """aliases""" 4
.el .IP \f(CWaliases\fR 4
.IX Item "aliases"
Arrayref of even more aliases for this kernel.  Fun Fun Fun!
.ie n .IP """on_connect""" 4
.el .IP \f(CWon_connect\fR 4
.IX Item "on_connect"
Coderef that is called when the connection has been made to the foreign 
kernel.  Normaly, you would use this to start the sessions that post events
to foreign kernels.
.Sp
Note, also, that the coderef will be executed from within an IKC channel
session, NOT within your own session.  This means that things like
\&\f(CW$poe_kernel\fR\->\fBdelay_set()\fR won't do what you think they should.
.Sp
It does, however, mean that you can get the session ID of the IKC channel for
this connection.
.Sp
.Vb 7
\&    POE::Component::IKC::Client\->spawn(
\&        ....
\&            on_connect=>sub {
\&                $heap\->{channel} = $poe_kernel\->get_active_session()\->ID;
\&            },
\&        ....
\&        );
.Ve
.Sp
However, IKC/monitor provides a more powerful mechanism for detecting
connections.  See POE::Component::IKC::Responder.
.ie n .IP """on_error""" 4
.el .IP \f(CWon_error\fR 4
.IX Item "on_error"
Coderef that is called for all connection errors. You could use this to
restart the connection attempt.  Parameters are \f(CW$operation, $errnum and
$errstr\fR, which correspond to POE::Wheel::SocketFactory's FailureEvent, 
which q.v.
.Sp
However, IKC/monitor provides a more powerful mechanism for detecting
errors.  See POE::Component::IKC::Responder.
.Sp
Note, also, that the coderef will be executed from within an IKC session,
NOT within your own session.  This means that things like
\&\f(CW$poe_kernel\fR\->\fBdelay_set()\fR won't do what you think they should.
.ie n .IP """subscribe""" 4
.el .IP \f(CWsubscribe\fR 4
.IX Item "subscribe"
Array ref of specifiers (either foreign sessions, or foreign states) that
you want to subscribe to.  on_connect will only be called when IKC has
managed to subscribe to all specifiers.  If it can't, it will \fBdie()\fR.  YOW
that sucks.  \f(CW\*(C`monitor\*(C'\fR will save us all.
.ie n .IP """serializers""" 4
.el .IP \f(CWserializers\fR 4
.IX Item "serializers"
Arrayref or scalar of the packages that you want to use for data
serialization.  First IKC tries to load each package.  Then, when connecting
to a server, it asks the server about each one until the server agrees to a
serializer that works on its side.
.Sp
A serializer package requires 2 functions : freeze (or nfreeze) and thaw. 
See \f(CW\*(C`POE::Filter::Reference\*(C'\fR.
.Sp
The default is \f(CW\*(C`[qw(Storable FreezeThaw
POE::Component::IKC::Freezer)]\*(C'\fR.  \f(CW\*(C`Storable\*(C'\fR and \f(CW\*(C`FreezeThaw\*(C'\fR are
modules in C on CPAN.  They are much much much faster then IKC's built-in
serializer \f(CW\*(C`POE::Component::IKC::Freezer\*(C'\fR.  This serializer uses
\&\f(CW\*(C`Data::Dumper\*(C'\fR and \f(CW\*(C`eval $code\*(C'\fR to get the deed done.  There is an obvious
security problem here.  However, it has the advantage of being pure Perl and
all modules come with the core Perl distribution.
.Sp
It should be noted that you should have the same version of \f(CW\*(C`Storable\*(C'\fR on
both sides, because some versions aren't mutually compatible.
.ie n .IP """protocol""" 4
.el .IP \f(CWprotocol\fR 4
.IX Item "protocol"
Which IKC negociation protocol to use.  The original protocol (\f(CW\*(C`IKC\*(C'\fR) was
synchronous and slow.  The new protocol (\f(CW\*(C`IKC0\*(C'\fR) sends all information at
once.  IKC0 will degrade gracefully to IKC, if the client and server don't
match.
.Sp
Default is IKC0.
.SH BUGS
.IX Header "BUGS"
.SH AUTHOR
.IX Header "AUTHOR"
Philip Gwyn, <perl\-ikc at pied.nu>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 1999\-2014 by Philip Gwyn.  All rights reserved.
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
.PP
See <http://www.perl.com/language/misc/Artistic.html>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
POE, POE::Component::IKC::Server, POE::Component::IKC::Responder.