Bio::WebAgent(3pm)

💖 Bio::WebAgent — a base class for Web (any protocol) access 💖

okay so bestie, welcome to Bio::WebAgent, a User Contributed Perl Documentation page, and honestly? she's giving foundation. the whole vibe here is: she doesn't do the work herself, she's the ✨ blueprint ✨ that all the bioperl net-touching modules inherit from. let's get into it 🫶

---

✨ NAME ✨

Bio::WebAgent — a base class for Web (any protocol) access 🌐

---

🦋 SYNOPSIS 🦋

  # This is a abstract superclass for bioperl modules accessing web
  # resources - normally you do not instantiate it but one of its
  # subclasess.

not me showing up to the party as an abstract superclass 💀 you literally do not instantiate her directly, bestie, you instantiate one of her subclasses. she's the mom, not the main character.

---

🌸 DESCRIPTION 🌸

so this abstract superclass is a subclass of LWP::UserAgent, and what she does is give you protocol independent access of remote locations over the Net. 🌈 no cap.

she handles the whole situation for you: error handling, proxies, and various net protocols. any BioPerl class that's going to touch the net should inherit from her. iykyk. for the deep details, go look at LWP::UserAgent — she's the blueprint's blueprint.

the interface is still evolving, ngl. for now, two public methods have been copied over from Bio::DB::WebDBSeqI: delay() and delay_policy. these exist to prevent overwhelming the server by rapidly repeated . ✋😭 (yes that sentence is incomplete in the original, i'm not fixing it, i'm just reporting the tea). ideally there should be a common abstract superclass with these. see delay.

---

👑 SEE ALSO 👑

• LWP::UserAgent
• Bio::DB::WebDBSeqI

---

💌 FEEDBACK 💌

📬 Mailing Lists

user feedback is an integral part of the evolution of this and other Bioperl modules, fr fr. send your comments and suggestions preferably to the Bioperl mailing list. your participation is much appreciated. 🫶

  bioperl-l@bioperl.org                  - General discussion
  http://bioperl.org/wiki/Mailing_lists  - About the mailing lists

🛟 Support

please direct usage questions or support issues to the mailing list:

bioperl-l@bioperl.org

and not to the module maintainer directly, bestie, please 🙈 there are so many experienced and reponsive experts who will be able look at the problem and quickly address it. if at all possible, include a thorough description of the problem with code and data examples — the more receipts the better.

🐛 Reporting Bugs

report bugs to the Bioperl bug tracking system so we can keep track of the bugs and their resolution. bug reports can be submitted via the web:

https://github.com/bioperl/bioperl-live/issues

---

✍️ AUTHOR ✍️

Heikki Lehvaslaiho, heikki-at-bioperl-dot-org

---

©️ COPYRIGHT ©️

Copyright (c) 2003, Heikki Lehvaslaiho and EMBL-EBI. All Rights Reserved.

this module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. 💅 slay.

---

⚠️ DISCLAIMER ⚠️

this software is provided "as is" without warranty of any kind.

periodt. no warranty, no promises, that's the deal 🎀

---

📖 APPENDIX 📖

the rest of the documentation details each of the object methods. internal methods are usually preceded with a _ (the underscore is the "don't touch, that's private" energy 💀).

🔗 url

Usage   : $agent->url
Returns : URL to reach out to Net
Args    : string

⏳ delay

Title   : delay
Usage   : $secs = $self->delay([$secs])
Function: get/set number of seconds to delay between fetches
Returns : number of seconds to delay
Args    : new value

NOTE: the default is to use the value specified by delay_policy(). this can be overridden by calling this method, or by passing the -delay argument to new().

🕰️ delay_policy

Title   : delay_policy
Usage   : $secs = $self->delay_policy
Function: return number of seconds to delay between calls to remote db
Returns : number of seconds to delay
Args    : none

NOTE: the default delay policy is 3s. override in subclasses to implement other delays. the timer has only second resolution, so the delay will actually be +/- 1s. 👀 precision is not her thing and that's okay.

😴 sleep

Title   : sleep
Usage   : $self->sleep
Function: sleep for a number of seconds indicated by the delay policy
Returns : none
Args    : none

NOTE: this method keeps track of the last time it was called and only imposes a sleep if it was called more recently than the delay_policy() allows.

---

and that's the whole page bestie, no crumbs left 💖 this was Bio::WebAgent(3pm) from perl v5.32.1, dated 2021-08-15 — go forth and inherit responsibly, mwah 💅✨