Octopussy::Service(3)

πŸ“¦ version 1.0.6, in ubuntu jammy

πŸ’– Octopussy::Service(3) πŸ’–

okay bestie, sit down, hydrate, because we're diving into Octopussy::Service β€” it's a Perl module, it's from the User Contributed Perl Documentation section of the manual (that's section 3, the "library functions" girlies πŸŽ€), and it is literally the whole Service-management backbone of Octopussy. Every function here is giving main character energy and we're gonna go through all of them. no skips. no cap.


✨ NAME ✨

Octopussy::Service β€” the Octopussy Service module. that's it, that's the name. iconic, brief, ate. πŸ’…


🌸 FUNCTIONS 🌸

every single one, in order, bestie. buckle up. πŸ¦‹

πŸ’« New(\%conf)

Creates a brand-new Service with the configuration $conf. new service, who dis.

Parameters:

  • \%conf β€” a hashref of the new Service configuration
🚨 okay important: the field 'name' only accepts [-_a-z0-9] characters. and 'Incoming' and 'Unknown' are rejected. like, flat-out refused. so don't even try it, she will not be taking questions. πŸ’€

πŸ’« Clone($service_orig, $service_clone)

yeah so this one exists. it clones. the original doc gives us nothing else and we respect the mystery. πŸ™ˆ

πŸ’« Remove($service)

Removes the Service $service. bye bestie, you will not be missed (jk, we'll miss you a little πŸ₯Ί).

Parameters:

  • $service β€” Name of the Service to remove

πŸ’« List()

Returns List of Services. the whole roster. the guest list. πŸ“‹

πŸ’« List_Used()

Returns List of Services used. (yes, there's a difference. List() is everybody, this is the ones actually showing up to the party πŸ’ƒ)

πŸ’« Unknowns(@services)

Returns list of Unknown Services in the @services list. she sniffs out the impostors. πŸ”

πŸ’« Filename($service)

Returns the XML filename for the service $service. yes queen, XML. it's giving 2005 and we love her for it. πŸ“„

πŸ’« Configuration($service)

Returns the configuration for the Service $service. the tea. the lore. πŸ«–

πŸ’« Configurations($sort)

Returns the configuration for all Services, sorted by $sort β€” and if you don't pass one, it defaults to 'name'. default queen behavior. πŸ‘‘

πŸ’« Msg_ID($service)

Returns the next available message id for Service $service. next up, next in line. 🎟️

πŸ’« Msg_ID_unique($service, $msgid)

Checks if $msgid is valid & unique for Service $service. two boxes, both gotta be checked. no duplicates allowed in this house. ✨

πŸ’« Add_Message($service, $mconf)

Adds Message $mconf to Service $service. welcome to the family, new message. 🫢

πŸ’« Remove_Message($service, $msgid)

Removes Message with id $msgid from Service $service. πŸ‘‹

πŸ’« Modify_Message($service, $msgid, $conf_modified)

Modifies Message with id $msgid from Service $service. glow-up time. πŸ’…

πŸ’« Move_Message($service, $msgid, $direction)

Moves Message $msgid up/down ('$direction') inside Service $service. she's moving, she's climbing, she's reordering the list. πŸ”₯

πŸ’« Messages(@services)

Get messages from the Service list @services, sorted by 'rank'. rank matters, bestie. always has. πŸ“Š

πŸ’« Messages_Configurations($service, $sort)

Get the configuration for all messages from $service, sorted by $sort. all of them. every last one. πŸ’–

πŸ’« Messages_Statistics($service)

Returns Messages statistics for Service $service. numbers! data! we love a receipts moment. πŸ“ˆ

πŸ’« Tables($service)

Get tables from service $service. πŸ—‚οΈ

πŸ’« Parse_Restart($service)

Restart Device parsing for the device with service $service. hit the reset button, babe. πŸ”„

πŸ’« Parse_Restart_Required($service)

Set 'reload_required' for the device with service $service. flag it. she needs a reload and she needs you to know. 🚩

πŸ’« Updates()

Gets Services Updates from Internet. yes, the actual internet. she goes outside. 🌐

πŸ’« Updates_Installation(@services)

Installs Services Updates. do it. install. ✨

πŸ’« Update_Get_Messages($service)

Returns Service Updates Messages. πŸ“¬

πŸ’« Updates_Diff($service)

Returns Service Updates differences. the diff. the before and after. the what-changed-since-you-last-texted. πŸ‘€

πŸ’« Valid_Name($name)

Checks that $name is valid for a Service name. vibe check on your naming choices, respectfully. βœ…


πŸ‘‘ AUTHOR πŸ‘‘

Sebastien Thebert <octo.devel@gmail.com> β€” the actual legend who wrote all of this. we stan. 🌟


so that's the whole page, bestie β€” every function, every param, every rejection rule, nothing left out. πŸ’œ

this page came to you courtesy of perl v5.22.2, dated 2016-05-04, and it lives in the Octopussy::Service(3) manual page. stay slay, read your manpages, and remember: 'Incoming' and 'Unknown' are never valid service names. periodt. πŸ’…βœ¨πŸ¦‹

πŸ“¦ where this page comes from