NAME

SYNOPSIS

  use Agent;

  my $t = new Agent::Transport(
        Medium => $name,
        Address => $addr
        ...
  );
  ...
  my $data = $t->recv( [%args] );

DESCRIPTION

CONSTRUCTOR

new( %args )

new() must be passed at least a Medium. The Address argument is strongly recomended (and should be required in most cases), as it's best not to let the system make assumptions. new() decides which Transport package to use base upon the "Medium" specified. "Address" is the destination in that medium. Any other arguments will be documented in the Agent::Transport subclasses (such as Agent::Transport::TCP).

STANDARD API METHODS

$t->recv()

"recv" attempts to retrieve a message (from said address, over said transport medium). Returns the data if called in a scalar context, or a list containing ($data, $from_address) if called in an array context. Returns nothing (i.e. sv_null or an empty list) if unsuccessful.

$t->transport()

Returns the transport medium over which the object communicates.

$t->address()

Returns the primary address at which the object can be reached.

$t->aliases()

Returns a list of addresses at which the object can be reached.

STANDARD SUBROUTINES

send( %args )

"send" too must be passed a Medium and an Address. In addition, it also needs a Message as either an anonymous array or a reference to an array.

valid_address( %args )

This checks to see if the Address provided is valid within the Medium specified by checking the syntax of the address. It does not check to see whether or not said address exists. Returns the address if successful, or nothing otherwise.

SEE ALSO

AUTHOR

COPYRIGHT

THANKS