| 1 | #/usr/bin/env perl | ||
| 2 | ############################################################################### | ||
| 3 | # | ||
| 4 | # @file Hook.pm | ||
| 5 | # | ||
| 6 | # @brief Eulerian Data Warehouse Peer Hook Base class Module definition. | ||
| 7 | # | ||
| 8 | # This module is aimed to provide callback hooks userfull to process reply data. | ||
| 9 | # Library user can create is own Hook class conforming to this module interface | ||
| 10 | # to handle reply data in specific manner. | ||
| 11 | # | ||
| 12 | # @author Thorillon Xavier:x.thorillon@eulerian.com | ||
| 13 | # | ||
| 14 | # @date 26/11/2021 | ||
| 15 | # | ||
| 16 | # @version 1.0 | ||
| 17 | # | ||
| 18 | ############################################################################### | ||
| 19 | # | ||
| 20 | # Setup module name | ||
| 21 | # | ||
| 22 | package API::Eulerian::EDW::Hook; | ||
| 23 | # | ||
| 24 | # Enforce compilor rules | ||
| 25 | # | ||
| 26 | use strict; use warnings; | ||
| 27 | # | ||
| 28 | # @brief Allocate a new Eulerian Data Warehouse Peer Hook. | ||
| 29 | # | ||
| 30 | # @param $class - Eulerian Data Warehouse Peer Hook Class. | ||
| 31 | # @param $setup - Setup attributes. | ||
| 32 | # | ||
| 33 | # @return Eulerian Data Warehouse Peer Hook instance. | ||
| 34 | # | ||
| 35 | sub new | ||
| 36 | { | ||
| 37 | my ( $class, $setup ) = @_; | ||
| 38 | my $self = bless( {}, $class ); | ||
| 39 | $self->setup( $setup ); | ||
| 40 | return $self; | ||
| 41 | } | ||
| 42 | # | ||
| 43 | # @brief Setup Eulerian Data Warehouse Peer Hook. | ||
| 44 | # | ||
| 45 | # @param $self - Eulerian Data Warehouse Peer Hook. | ||
| 46 | # @param $setup - Setup entries. | ||
| 47 | # | ||
| 48 | sub setup | ||
| 49 | { | ||
| 50 | my ( $self, $setup ) = @_; | ||
| 51 | } | ||
| 52 | # | ||
| 53 | # @brief | ||
| 54 | # | ||
| 55 | # @param $self - Eulerian Data Warehouse Peer Hook. | ||
| 56 | # @param $uuid - UUID of Eulerian Analytics Analysis. | ||
| 57 | # @param $start - Timerange begin. | ||
| 58 | # @param $end - Timerange end. | ||
| 59 | # @param $columns - Array of Columns definitions. | ||
| 60 | # | ||
| 61 | sub on_headers | ||
| 62 | { | ||
| 63 | my ( $self, $uuid, $start, $end, $columns ) = @_; | ||
| 64 | } | ||
| 65 | # | ||
| 66 | # @brief | ||
| 67 | # | ||
| 68 | # @param $self - Eulerian Data Warehouse Peer Hook. | ||
| 69 | # @param $uuid - UUID of Eulerian Analytics Analysis. | ||
| 70 | # @param $rows - Array of Array of Columns values. | ||
| 71 | # | ||
| 72 | sub on_add | ||
| 73 | { | ||
| 74 | my ( $self, $uuid, $rows ) = @_; | ||
| 75 | } | ||
| 76 | # | ||
| 77 | # @brief | ||
| 78 | # | ||
| 79 | # @param $self - Eulerian Data Warehouse Peer Hook. | ||
| 80 | # @param $uuid - UUID of Eulerian Analytics Analysis. | ||
| 81 | # @param $rows - Array of Array of Columns values. | ||
| 82 | # | ||
| 83 | sub on_replace | ||
| 84 | { | ||
| 85 | my ( $self, $uuid, $rows ) = @_; | ||
| 86 | } | ||
| 87 | # | ||
| 88 | # @brief | ||
| 89 | # | ||
| 90 | # @param $self - Eulerian Data Warehouse Peer Hook. | ||
| 91 | # @param $uuid - UUID of Eulerian Analytics Analysis. | ||
| 92 | # @param $progress - Progression value. | ||
| 93 | # | ||
| 94 | sub on_progress | ||
| 95 | { | ||
| 96 | my ( $self, $uuid, $progress ) = @_; | ||
| 97 | } | ||
| 98 | # | ||
| 99 | # @brief | ||
| 100 | # | ||
| 101 | # @param $self - Eulerian Data Warehouse Peer Hook. | ||
| 102 | # @param $uuid - UUID of Eulerian Analytics Analysis. | ||
| 103 | # @param $token - AES Token or Bearer. | ||
| 104 | # @param $errnum - Error number. | ||
| 105 | # @param $err - Error description. | ||
| 106 | # @param $updated - Count of updates on server. | ||
| 107 | # | ||
| 108 | sub on_status | ||
| 109 | { | ||
| 110 | my ( $self, $uuid, $token, $errnum, $err, $updated ) = @_; | ||
| 111 | } | ||
| 112 | # | ||
| 113 | # Endup module properly | ||
| 114 | # | ||
| 115 | 1; | ||
| 116 | |||
| 117 | __END__ |