1# ======================================================================
2#
3# Copyright (C) 2000-2004 Paul Kulchenko (paulclinger@yahoo.com)
4#
5# SOAP::Lite is free software; you can redistribute it
6# and/or modify it under the same terms as Perl itself.
7#
8# ======================================================================
9
10=pod
11
12=head1 NAME
13
14SOAP::Client - exists purely as a superclass for client classes declared by the various SOAP::Lite transport modules.
15
16=head1 DESCRIPTION
17
18The SOAP::Client class exists purely as a superclass for client classes
19declared by the various SOAP::Lite transport modules. The methods it
20provides are all simple accessors; they return the current value when
21called with no arguments or set the attribute value and return the object
22reference when called with an argument. These attributes include:
23
24=head1 METHODS
25
26=over
27
28=item code, message, status
29
30Stores the response code, message, and status from the most-recent send attempt. For some protocols, such as FTP, the same value is used for all three because of the lack of finer-grained detail (the default is to ensure that all three attributes contain data, even if redundant). Other protocols (such as HTTP) have distinct values in each.
31
32=item endpoint
33
34Identifies the current endpoint to which messages are being sent. This should match the value of the transport method from the L<SOAP::Transport> class, but setting this doesn't propagate to the transport object. It is better to use the transport object (or the shortcut via the SOAP::Lite object itself) when setting this.
35
36=item is_success
37
38The success or failure of the most-recent transmission is noted here as a boolean value.
39
40=item options
41
42The options attribute keeps a hash-table reference of additional  options and their values. At present, only one option is used by any of the transport modules:
43
44=over
45
46=item compress_threshold
47
48The value of this option should be a numerical value. If set, and if the Compress::Zlib library is available, messages whose size in bytes exceeds this value will be compressed before sending. Both ends of the conversation must have it enabled.
49
50=back
51
52Other options may be defined using this mechanism. Note that setting the options using this accessor requires a full hash reference be passed. To set just one or a few values, consider retrieving the current reference value and using it to set the key(s).
53
54=back
55
56=head1 SEE ALSO
57
58L<SOAP::Server>
59
60=head1 ACKNOWLEDGEMENTS
61
62Special thanks to O'Reilly publishing which has graciously allowed SOAP::Lite to republish and redistribute large excerpts from I<Programming Web Services with Perl>, mainly the SOAP::Lite reference found in Appendix B.
63
64=head1 COPYRIGHT
65
66Copyright (C) 2000-2004 Paul Kulchenko. All rights reserved.
67
68This library is free software; you can redistribute it and/or modify
69it under the same terms as Perl itself.
70
71=head1 AUTHORS
72
73Paul Kulchenko (paulclinger@yahoo.com)
74
75Randy J. Ray (rjray@blackperl.com)
76
77Byrne Reese (byrne@majordojo.com)
78
79=cut
80