SOAP::Client(3)

🌸 NAME 🌸

okay so SOAP::Client(3) is from User Contributed Perl Documentation, and the whole vibe is: SOAP::Client exists purely as a superclass for client classes declared by the various SOAP::Lite transport modules. That’s it, bestie β€” iconic minimalism. πŸ’…

πŸ’– DESCRIPTION πŸ’–

The SOAP::Client class exists purely as a superclass for client classes declared by the various SOAP::Lite transport modules. The methods it provides are all simple accessors; they return the current value when called with no arguments, or set the attribute value and return the object reference when called with an argument. These attributes include: ✨

πŸŽ€ METHODS πŸŽ€

  • code, message, status β€” stores 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. 🫢
  • endpoint β€” identifies the current endpoint to which messages are being sent. This should match the value of the transport method from the 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. πŸ¦‹
  • is_success β€” the success or failure of the most-recent transmission is noted here as a boolean value. ⭐
  • options β€” the 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:
    • compress_threshold β€” the 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. πŸ”₯

Other 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). πŸ’œ

🌈 SEE ALSO 🌈

  • SOAP::Server πŸ‘‘

🫢 ACKNOWLEDGEMENTS 🫢

Special thanks to O’Reilly publishing which has graciously allowed SOAP::Lite to republish and redistribute large excerpts from Programming Web Services with Perl, mainly the SOAP::Lite reference found in Appendix B. πŸ“šβœ¨

Copyright (C) 2000-2004 Paul Kulchenko. All rights reserved.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. πŸŽ€

πŸ‘‘ AUTHORS πŸ‘‘

  • Paul Kulchenko (paulclinger@yahoo.com)
  • Randy J. Ray (rjray@blackperl.com)
  • Byrne Reese (byrne@majordojo.com)

okay bye bestie β€” source/version: perl v5.42.0 ✨ date: 2024-03-04 πŸŽ€ and SOAP::Client(3) is out πŸ’…πŸ«Ά

πŸ“¦ where this page comes from