bionic (3) NetSDS::EDR.3pm.gz

Provided by: libnetsds-perl_1.301-3_all bug

NAME

       NetSDS::EDR - read/write Event Details Records

SYNOPSIS

               use NetSDS::EDR;

               my $edr = NetSDS::EDR->new(
                       filename => '/mnt/billing/call-stats.dat',
               );

               ...

               $edr->write(
                       {
                       callerid => '80441234567',
                       clip => '89001234567',
                       start_time => '2006-12-55 12:21:46',
                       end_time => '2008-12-55 12:33:22'
                       }
               );

DESCRIPTION

       "NetSDS::EDR" module implements API for writing EDR (Event Details Record) files form applications.

       EDR itself is set of structured data describing details of some event. Exact structure depends on event
       type and so hasn't fixed structure.

       In NetSDS EDR data is written to plain text files as JSON structures one row per record.

CLASS API

       new(%params) - class constructor
           Parameters:

           * filename - EDR file name

           Example:

               my $edr = NetSDS::EDR->new(
                           filename => '/mnt/stat/ivr.dat',
                   );

       write($rec1 [,$rec2 [...,$recN]]) - write EDR to file
           This methods converts records to JSON and write to file.  Each record writing to one separate string.

           Example:

                   $edr->write({from => '380441234567', to => '5552222', status => 'busy'});

EXAMPLES

       See "samples" directory.

TODO

       * Handle I/O errors when write EDR data.

AUTHOR

       Michael Bochkaryov <misha@rattler.kiev.ua>

LICENSE

       Copyright (C) 2008-2009 Net Style Ltd.

       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