netsds::edr(3pm) [debian man page]

NetSDS::EDR(3pm)					User Contributed Perl Documentation					  NetSDS::EDR(3pm)

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

perl v5.10.1							    2010-04-28							  NetSDS::EDR(3pm)

NetSDS::Feature(3pm)					User Contributed Perl Documentation				      NetSDS::Feature(3pm)

NAME

       NetSDS::Feature - abstract application feature

SYNOPSIS

	       package NetSDS::Feature::DBI;

	       use DBI;
	       use base 'NetSDS::Feature';

	       sub init {
		       my ($self) = @_;

		       my $dsn = $self->conf->{dsn};
		       my $user = $self->conf->{user};
		       my $passwd = $self->conf->{passwd};

		       $self->{dbconn} = DBI->connect($dsn, $user, $passwd);

	       }

	       # Sample method - DBI::do proxy
	       sub do {

		       my $self = shift @_;
		       return $self->{dbconn}->do(@_);
	       }

	       1;

DESCRIPTION

       Application "features" are Perl5 packages with unified API for easy integration of some functionality into NetSDS applications
       infrastructure.

       "NetSDS::Feature" module contains superclass for application features providing the following common feature functionality:

	       * class construction
	       * initialization stub
	       * logging

CLASS METHODS

       create($app, $conf) - feature constructor
       init() - feature initialization
	   This method should be rewritten with feature functionality implementation.  It's possibly to use application and configuration handlers
	   at this time.

	   Example:

		   sub init {
			   my ($self) = @_;

			   $self->{answer} = $self->conf->{answer} || '42';

			   my $pid = $self->app->pid();

			   if ($self->app->daemon()) {
				   $self->log("info", "Seems we are in a daemon mode");
			   }
		   }

OBJECT METHODS

       app() - application object
	   This method allows to use application methods and properties.

		   print "Feature included from app: " . $self->app->name;

       conf() - feature configuration
	   This method provides access to feature configuration.

       log($level, $message) - implements logging
	   Example:

		   # Write log message
		   $self->log("info", "Application does something interesting.");

	   See NetSDS::Logger documentation for details.

EXAMPLES

       See "samples/app_features.pl" script.

SEE ALSO

       o   NetSDS::App

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

perl v5.10.1							    2010-04-28						      NetSDS::Feature(3pm)