.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "NetSDS::Class::Abstract 3pm"
.TH NetSDS::Class::Abstract 3pm "2021-12-26" "perl v5.32.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
NetSDS::Class::Abstract \- superclass for all NetSDS APIs
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&        package MyClass;
\&        use base \*(AqNetSDS::Class::Abstract\*(Aq;
\&
\&        _\|_PACKAGE_\|_\->mk_accessors(qw/my_field/);
\&
\&        sub error_sub {
\&                my ($self) = @_;
\&                if (!$self\->my_field) {
\&                        return $self\->error("No my_field defined");
\&                }
\&        }
\&
\&        1;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`NetSDS::Class::Abstract\*(C'\fR is a superclass for all other NetSDS classes, containing the following functionality:
.IP "\(bu" 4
common class constructor
.IP "\(bu" 4
safe modules inclusion
.IP "\(bu" 4
class and objects accessors
.IP "\(bu" 4
logging
.IP "\(bu" 4
error handling;
.PP
All other class/object APIs should inherit this class to use it's functionality in standard way.
.SH "CONSTRUCTOR, INITIALIZATION, APPLICATION"
.IX Header "CONSTRUCTOR, INITIALIZATION, APPLICATION"
.IP "\fBnew(%params)\fR \- common constructor" 4
.IX Item "new(%params) - common constructor"
\&\f(CW\*(C`new()\*(C'\fR method implements common constructor for NetSDS classes.
Constructor may be overwriten in inherited classes and usually
this happens to implement module specific functionality.
.Sp
Constructor requres parameters as hash that are set as object properties.
.Sp
.Vb 4
\&        my $object = NetSDS::SomeClass\->new(
\&                foo => \*(Aqabc\*(Aq,
\&                bar => \*(Aqdef\*(Aq,
\&        );
.Ve
.IP "\fBmk_class_accessors(@properties)\fR \- class properties accessor" 4
.IX Item "mk_class_accessors(@properties) - class properties accessor"
See Class::Accessor for details.
.Sp
.Vb 1
\&        _\|_PACKAGE_\|_\->mk_class_accessors(\*(Aqfoo\*(Aq, \*(Aqbar\*(Aq);
.Ve
.IP "\fBmk_accessors(@propertire)\fR \- object properties accessors" 4
.IX Item "mk_accessors(@propertire) - object properties accessors"
See Class::Accessor::Class for details.
.Sp
.Vb 1
\&        $self\->mk_accessors(\*(Aqfoo\*(Aq, \*(Aqbar\*(Aq);
.Ve
.Sp
Other \f(CW\*(C`Class::Accessor::Class\*(C'\fR methods available as well.
.IP "\fBuse_modules(@modules_list)\fR \- load modules on demand" 4
.IX Item "use_modules(@modules_list) - load modules on demand"
\&\f(CW\*(C`use_modules()\*(C'\fR provides safe on demand modules loader.
It requires list of modules names as parameters
.Sp
Return 1 in case of success or \f(CW\*(C`undef\*(C'\fR if faied. Error messages in case
of failure are available using \f(CW\*(C`errstr()\*(C'\fR call.
.Sp
Example:
.Sp
.Vb 4
\&        # Load modules for daemonization
\&        if ($daemon_mode) {
\&                $self\->use_modules("Proc::Daemon", "Proc::PID::File");
\&        }
.Ve
.IP "\fB\fBunbless()\fB\fR \- return unblessed object" 4
.IX Item "unbless() - return unblessed object"
Return unblessed data structure of object that may be used when some
code requires non blessed structures (like \s-1JSON\s0 serialization).
.Sp
Example:
.Sp
.Vb 1
\&        my $var = $obj\->unbless();
.Ve
.SH "LOGGING"
.IX Header "LOGGING"
.IP "\fB\fBlogger()\fB\fR \- get/set logging handler" 4
.IX Item "logger() - get/set logging handler"
\&\f(CW\*(C`logger\*(C'\fR property is an object that should provide functionality
handling log messaging. Usually it's object of NetSDS::Logger
class or \f(CW\*(C`undef\*(C'\fR. However it may another object implementing
non-standard features like sending log to e\-mail or to \s-1DBMS.\s0
.Sp
Example:
.Sp
.Vb 3
\&        # Set logger and send log message
\&        $obj\->logger(NetSDS::Logger\->new());
\&        $obj\->log("info", "Logger connected");
.Ve
.IP "\fBlog($level, \f(CB$message\fB)\fR \- write log message" 4
.IX Item "log($level, $message) - write log message"
Paramters: log level, log message
.Sp
.Vb 1
\&        $obj\->log("info", "We still alive");
.Ve
.SH "ERROR HANDLING"
.IX Header "ERROR HANDLING"
.IP "\fBerror($msg, [$code])\fR \- set error message and code" 4
.IX Item "error($msg, [$code]) - set error message and code"
\&\f(CW\*(C`error()\*(C'\fR method set error message and optional error code.
It can be invoked in both class and object contexts.
.Sp
Example 1: set class error
.Sp
.Vb 1
\&        NetSDS::Foo\->error("Mistake found");
.Ve
.Sp
Example 2: set object error with code
.Sp
.Vb 1
\&        $obj\->error("Can\*(Aqt launch rocket", BUG_STUPID);
.Ve
.IP "\fB\fBerrstr()\fB\fR \- retrieve error message" 4
.IX Item "errstr() - retrieve error message"
\&\f(CW\*(C`errstr()\*(C'\fR method returns error string in both object and class contexts.
.Sp
Example:
.Sp
.Vb 1
\&        warn "We have an error: " . $obj\->errstr;
.Ve
.IP "\fB\fBerrcode()\fB\fR \- retrieve error code" 4
.IX Item "errcode() - retrieve error code"
\&\f(CW\*(C`errcode()\*(C'\fR method returns error code in both object and class contexts.
.Sp
Example:
.Sp
.Vb 3
\&        if ($obj\->errcode == 42) {
\&                print "Epic fail! We\*(Aqve found an answer!";
\&        }
.Ve
.SH "EXAMPLES"
.IX Header "EXAMPLES"
See \f(CW\*(C`samples\*(C'\fR directory and other \f(CW\*(C`NetSDS\*(C'\fR moduleis for examples of code.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Class::Accessor::Class
.SH "AUTHOR"
.IX Header "AUTHOR"
Michael Bochkaryov <misha@rattler.kiev.ua>
.SH "LICENSE"
.IX Header "LICENSE"
Copyright (C) 2008\-2009 Net Style Ltd.
.PP
This program is free software; you can redistribute it and/or modify
it under the terms of the \s-1GNU\s0 General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
.PP
This program is distributed in the hope that it will be useful,
but \s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of
\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0  See the
\&\s-1GNU\s0 General Public License for more details.
.PP
You should have received a copy of the \s-1GNU\s0 General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, \s-1MA\s0  02111\-1307  \s-1USA\s0