NAME

API::Eulerian::EDW::Hook - Eulerian Data Warehouse Peer Hook module.

DESCRIPTION

This module provides callback hooks interface used to process analysis reply data. Library user can create their own derived class matching this module interface. It permits to process reply data in a specific manner.

METHODS

new()

Create a new instance of Eulerian Data Warehouse Peer Hook

input

• setup - Hash reference of Hook parameters.

output

• API::Eulerian::EDW::Hook instance.

setup()

Setup Eulerian Data Warehouse Peer Hook

input

• setup - Hash reference of Hook parameters.

on_headers()

Interface definition of the callback function used whenever a new Eulerian Data Warehouse Started.

input

• uuid - Eulerian Data Warehouse Analysis identifier.

• start - UNIX Timestamp of the beginning of Eulerian Data Warehouse Analysis.

• end - UNIX Timestamp of the end of Eulerian Data Warehouse Analysis.

• headers - Perl Array of Columns headers.

on_add()

Interface definition of the callback function used to proceed an Eulerian Data Warehouse Row outputs Analysis.

input

• uuid - Eulerian Data Warehouse Analysis identifier.

• rows - Array of Array of columns values.

on_replace()

Interface definition of the callback function used to proceed an Eulerian Data Warehouse Distinct and Pivot outputs Analysis.

input

• uuid - Eulerian Data Warehouse Analysis identifier.

• rows - Array of Array of columns values.

on_progress()

Interface definition of the callback function used to control the progression of an Eulerian Data Warehouse Analysis.

input

• uuid - Eulerian Data Warehouse Analysis identifier.

• progress - Progression value.

on_status()

Interface definition of the callback function called at the end of an Eulerian Data Warehouse Analysis.

input

• uuid - Eulerian Data Warehouse Analysis identifier.

• token - AES token.

• errnum - Error number.

• err - Error message.

• updated - Updated events count.

AUTHOR

Xavier Thorillon <x.thorillon@eulerian.com>

COPYRIGHT

Copyright (c) 2008 Eulerian Technologies Ltd http://www.eulerian.com

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

cpanm API::Eulerian

perl -MCPAN -e shell
install API::Eulerian