NAME

POE::Component::IKC::Client - POE Inter-Kernel Communication server

SYNOPSIS

    use POE;
    use POE::Component::IKC::Client;
    create_ikc_client(
        ip=>$ip, 
        port=>$port,
        name=>"Client$$",
        on_connect=>\&create_sessions,
        subscribe=>[qw(poe:/*/timserver)],);
    ...
    $poe_kernel->run();

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.

EXPORTED FUNCTIONS

create_ikc_client

This function initiates all the work of connecting to an IKC server. Parameters are :

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.

port

Port to connect to. Can be numeric (80) or a service ('http').

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.

on_connect

Code ref 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.

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 each specifier. If it can't, it will die().

BUGS

AUTHOR

Philip Gwyn, <fil@pied.nu>

SEE ALSO

POE, POE::Component::IKC::Server