The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

App::OverWatch::Notify - Notify base class

VERSION

version 0.1

SYNOPSIS

  use App::OverWatch;
  my $OverWatch = App::OverWatch->new();
  [...]
  my $Notify = $OverWatch->Notify();

NAME

App::OverWatch::Notify - App::OverWatch Notification System

METHODS

new

Create an App::OverWatch::Notify object - usually handled by App::OverWatch.

create_notification

Create a notification to allow systems to notify you of events.

   $Notify->create_notification({
      system    => 'global',
      subsystem => 'uk',
      worker    => 'myworkerid',
   });

delete_notification

Destroy a notification.

   $Notify->delete_notification({
      system    => 'global',
      subsystem => 'uk',
      worker    => 'myworkerid',
   });

delete_all_notifications

Destroy all notifications for a worker.

   $Notify->delete_all_notifications({
      worker    => 'myworkerid',
   });

check_notifications

Check to see if notification have been flagged for a worker.

   my @Notifications = $Notify->check_notifications({
      worker    => 'myworkerid',
   });

notify

Fire any notifications for a given system/subsystem.

   $Notify->notify({
      system    => 'global',
      subsystem => 'uk',
      text      => 'Some textual information',
   });

AUTHOR

Chris Hughes <chrisjh@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2015 by Chris Hughes.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.