NAME

Tangence::Client - mixin class for building a Tangence client

SYNOPSIS

This class is a mixin, it cannot be directly constructed

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;

DESCRIPTION

This module provides mixin to implement a Tangence 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.

This is a subclass of Tangence::Stream which provides implementations of the required handle_request_ methods. A class mixing in Tangence::Client must still provide the tangence_write method required for sending data to the server.

For an example of a class that uses this mixin, see Net::Async::Tangence::Client.

PROVIDED METHODS

The following methods are provided by this mixin.

$rootobj = $client->rootobj

Returns a Tangence::ObjectProxy to the server's root object

$registry = $client->registry

Returns a Tangence::ObjectProxy to the server's object registry

$client->tangence_connected( %args )

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.

It takes the following named arguments:

do_init => BOOL

Optional. If true, sends the MSG_INIT message first, to negotiate protocol version number. This will be performed by default in a future version, but is left optional for now, to accomodate servers that do not yet recognise MSG_INIT.

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.

$on_root->( $rootobj )

on_registry => CODE

Optional callback to be invoked once the registry has been returned. It will be passed a Tangence::ObjectProxy to the registry.

$on_registry->( $registry )

AUTHOR

Paul Evans <leonerd@leonerd.org.uk>