=for comment POD_DERIVED_INDEX_GENERATED
The following documentation is automatically generated.  Please do not edit
this file, but rather the original, inline with Protocol::SOCKS::Client
at lib/Protocol/SOCKS/Client.pm
(on the system that originally ran this).
If you do edit this file, and don't want your changes to be removed, make
sure you change the first line.

=encoding utf8

=cut

=head1 NAME

Protocol::SOCKS::Client - client support for SOCKS protocol

=head1 VERSION

Version 0.002

=head1 DESCRIPTION

This provides an abstraction for dealing with the client side of the SOCKS protocol.

=head1 METHODS

=head2 completion

Returns the completion future.

=head2 auth

Returns the auth Future.

=head2 auth_methods

Returns the list of auth methods we can handle.

=head2 init_packet

Initial client packet.

=head2 on_read

Handler for reading data from the server.

=head2 init

Startup - writes the initial packet to the server.

=head2 connect

Issues a connection request.

=head2 parse_reply

Parse a server reply.

=head1 INHERITED METHODS

=over 4

=item L<Protocol::SOCKS>

L<extract_address|Protocol::SOCKS/extract_address>, L<new|Protocol::SOCKS/new>, L<new_future|Protocol::SOCKS/new_future>, L<pack_address|Protocol::SOCKS/pack_address>, L<pack_fqdn|Protocol::SOCKS/pack_fqdn>, L<pack_ipv4|Protocol::SOCKS/pack_ipv4>, L<pack_ipv6|Protocol::SOCKS/pack_ipv6>, L<version|Protocol::SOCKS/version>, L<write|Protocol::SOCKS/write>

=back

=head1 AUTHOR

Tom Molesworth <cpan@perlsite.co.uk>

=head1 LICENSE

Copyright Tom Molesworth 2014. Licensed under the same terms as Perl itself.
