perlapi.1

视频监控网络部分的协议ddns,的模块的实现代码,请大家大胆指正.

.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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" ''
'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 turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" 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 "PERLAPI 1"
.TH PERLAPI 1 "2007-12-18" "perl v5.10.0" "Perl Programmers Reference Guide"
.\" 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"
perlapi \- autogenerated documentation for the perl public API
.SH "DESCRIPTION"
.IX Xref "Perl API API api"
.IX Header "DESCRIPTION"
This file contains the documentation of the perl public \s-1API\s0 generated by
embed.pl, specifically a listing of functions, macros, flags, and variables
that may be used by extension writers.  The interfaces of any functions that
are not listed here are subject to change without notice.  For this reason,
blindly using functions listed in proto.h is to be avoided when writing
extensions.
.PP
Note that all Perl \s-1API\s0 global variables must be referenced with the \f(CW\*(C`PL_\*(C'\fR
prefix.  Some macros are provided for compatibility with the older,
unadorned names, but this support may be disabled in a future release.
.PP
The listing is alphabetical, case insensitive.
.ie n .SH """Gimme"" Values"
.el .SH "``Gimme'' Values"
.IX Header "Gimme Values"
.IP "\s-1GIMME\s0" 8
.IX Xref "GIMME"
.IX Item "GIMME"
A backward-compatible version of \f(CW\*(C`GIMME_V\*(C'\fR which can only return
\&\f(CW\*(C`G_SCALAR\*(C'\fR or \f(CW\*(C`G_ARRAY\*(C'\fR; in a void context, it returns \f(CW\*(C`G_SCALAR\*(C'\fR.
Deprecated.  Use \f(CW\*(C`GIMME_V\*(C'\fR instead.
.Sp
.Vb 1
\&        U32     GIMME
.Ve
.IP "\s-1GIMME_V\s0" 8
.IX Xref "GIMME_V"
.IX Item "GIMME_V"
The XSUB-writer's equivalent to Perl's \f(CW\*(C`wantarray\*(C'\fR.  Returns \f(CW\*(C`G_VOID\*(C'\fR,
\&\f(CW\*(C`G_SCALAR\*(C'\fR or \f(CW\*(C`G_ARRAY\*(C'\fR for void, scalar or list context,
respectively.
.Sp
.Vb 1
\&        U32     GIMME_V
.Ve
.IP "G_ARRAY" 8
.IX Xref "G_ARRAY"
.IX Item "G_ARRAY"
Used to indicate list context.  See \f(CW\*(C`GIMME_V\*(C'\fR, \f(CW\*(C`GIMME\*(C'\fR and
perlcall.
.IP "G_DISCARD" 8
.IX Xref "G_DISCARD"
.IX Item "G_DISCARD"
Indicates that arguments returned from a callback should be discarded.  See
perlcall.
.IP "G_EVAL" 8
.IX Xref "G_EVAL"
.IX Item "G_EVAL"
Used to force a Perl \f(CW\*(C`eval\*(C'\fR wrapper around a callback.  See
perlcall.
.IP "G_NOARGS" 8
.IX Xref "G_NOARGS"
.IX Item "G_NOARGS"
Indicates that no arguments are being sent to a callback.  See
perlcall.
.IP "G_SCALAR" 8
.IX Xref "G_SCALAR"
.IX Item "G_SCALAR"
Used to indicate scalar context.  See \f(CW\*(C`GIMME_V\*(C'\fR, \f(CW\*(C`GIMME\*(C'\fR, and
perlcall.
.IP "G_VOID" 8
.IX Xref "G_VOID"
.IX Item "G_VOID"
Used to indicate void context.  See \f(CW\*(C`GIMME_V\*(C'\fR and perlcall.
.SH "Array Manipulation Functions"
.IX Header "Array Manipulation Functions"
.IP "AvFILL" 8
.IX Xref "AvFILL"
.IX Item "AvFILL"
Same as \f(CW\*(C`av_len()\*(C'\fR.  Deprecated, use \f(CW\*(C`av_len()\*(C'\fR instead.
.Sp
.Vb 1
\&        int     AvFILL(AV* av)
.Ve
.IP "av_clear" 8
.IX Xref "av_clear"
.IX Item "av_clear"
Clears an array, making it empty.  Does not free the memory used by the
array itself.
.Sp
.Vb 1
\&        void    av_clear(AV* ar)
.Ve
.IP "av_create_and_push" 8
.IX Xref "av_create_and_push"
.IX Item "av_create_and_push"
Push an \s-1SV\s0 onto the end of the array, creating the array if necessary.
A small internal helper function to remove a commonly duplicated idiom.
.Sp
\&\s-1NOTE:\s0 this function is experimental and may change or be
removed without notice.
.Sp
.Vb 1
\&        void    av_create_and_push(AV **const avp, SV *const val)
.Ve
.IP "av_create_and_unshift_one" 8
.IX Xref "av_create_and_unshift_one"
.IX Item "av_create_and_unshift_one"
Unshifts an \s-1SV\s0 onto the beginning of the array, creating the array if
necessary.
A small internal helper function to remove a commonly duplicated idiom.
.Sp
\&\s-1NOTE:\s0 this function is experimental and may change or be
removed without notice.
.Sp
.Vb 1
\&        SV**    av_create_and_unshift_one(AV **const avp, SV *const val)
.Ve
.IP "av_delete" 8
.IX Xref "av_delete"
.IX Item "av_delete"
Deletes the element indexed by \f(CW\*(C`key\*(C'\fR from the array.  Returns the
deleted element. If \f(CW\*(C`flags\*(C'\fR equals \f(CW\*(C`G_DISCARD\*(C'\fR, the element is freed
and null is returned.
.Sp
.Vb 1
\&        SV*     av_delete(AV* ar, I32 key, I32 flags)
.Ve
.IP "av_exists" 8
.IX Xref "av_exists"
.IX Item "av_exists"
Returns true if the element indexed by \f(CW\*(C`key\*(C'\fR has been initialized.
.Sp
This relies on the fact that uninitialized array elements are set to
\&\f(CW&PL_sv_undef\fR.
.Sp
.Vb 1
\&        bool    av_exists(AV* ar, I32 key)
.Ve
.IP "av_extend" 8
.IX Xref "av_extend"
.IX Item "av_extend"
Pre-extend an array.  The \f(CW\*(C`key\*(C'\fR is the index to which the array should be
extended.
.Sp
.Vb 1
\&        void    av_extend(AV* ar, I32 key)
.Ve
.IP "av_fetch" 8
.IX Xref "av_fetch"
.IX Item "av_fetch"
Returns the \s-1SV\s0 at the specified index in the array.  The \f(CW\*(C`key\*(C'\fR is the
index.  If \f(CW\*(C`lval\*(C'\fR is set then the fetch will be part of a store.  Check
that the return value is non-null before dereferencing it to a \f(CW\*(C`SV*\*(C'\fR.
.Sp
See \*(L"Understanding the Magic of Tied Hashes and Arrays\*(R" in perlguts for
more information on how to use this function on tied arrays.
.Sp
.Vb 1
\&        SV**    av_fetch(AV* ar, I32 key, I32 lval)
.Ve
.IP "av_fill" 8
.IX Xref "av_fill"
.IX Item "av_fill"
Set the highest index in the array to the given number, equivalent to
Perl's \f(CW\*(C`$#array = $fill;\*(C'\fR.
.Sp
The number of elements in the an array will be \f(CW\*(C`fill + 1\*(C'\fR after
\&\fIav_fill()\fR returns.  If the array was previously shorter then the
additional elements appended are set to \f(CW\*(C`PL_sv_undef\*(C'\fR.  If the array
was longer, then the excess elements are freed.  \f(CW\*(C`av_fill(av, \-1)\*(C'\fR is
the same as \f(CW\*(C`av_clear(av)\*(C'\fR.
.Sp
.Vb 1
\&        void    av_fill(AV* ar, I32 fill)
.Ve
.IP "av_len" 8
.IX Xref "av_len"
.IX Item "av_len"
Returns the highest index in the array.  The number of elements in the
array is \f(CW\*(C`av_len(av) + 1\*(C'\fR.  Returns \-1 if the array is empty.
.Sp
.Vb 1
\&        I32     av_len(const AV* ar)
.Ve
.IP "av_make" 8
.IX Xref "av_make"
.IX Item "av_make"
Creates a new \s-1AV\s0 and populates it with a list of SVs.  The SVs are copied
into the array, so they may be freed after the call to av_make.  The new \s-1AV\s0
will have a reference count of 1.
.Sp
.Vb 1
\&        AV*     av_make(I32 size, SV** svp)
.Ve
.IP "av_pop" 8
.IX Xref "av_pop"
.IX Item "av_pop"
Pops an \s-1SV\s0 off the end of the array.  Returns \f(CW&PL_sv_undef\fR if the array
is empty.
.Sp
.Vb 1
\&        SV*     av_pop(AV* ar)
.Ve
.IP "av_push" 8
.IX Xref "av_push"
.IX Item "av_push"
Pushes an \s-1SV\s0 onto the end of the array.  The array will grow automatically
to accommodate the addition.
.Sp
.Vb 1
\&        void    av_push(AV* ar, SV* val)
.Ve
.IP "av_shift" 8
.IX Xref "av_shift"
.IX Item "av_shift"
Shifts an \s-1SV\s0 off the beginning of the array.
.Sp
.Vb 1
\&        SV*     av_shift(AV* ar)
.Ve
.IP "av_store" 8
.IX Xref "av_store"
.IX Item "av_store"
Stores an \s-1SV\s0 in an array.  The array index is specified as \f(CW\*(C`key\*(C'\fR.  The
return value will be \s-1NULL\s0 if the operation failed or if the value did not
need to be actually stored within the array (as in the case of tied
arrays). Otherwise it can be dereferenced to get the original \f(CW\*(C`SV*\*(C'\fR.  Note
that the caller is responsible for suitably incrementing the reference
count of \f(CW\*(C`val\*(C'\fR before the call, and decrementing it if the function
returned \s-1NULL\s0.
.Sp
See \*(L"Understanding the Magic of Tied Hashes and Arrays\*(R" in perlguts for
more information on how to use this function on tied arrays.
.Sp
.Vb 1
\&        SV**    av_store(AV* ar, I32 key, SV* val)
.Ve
.IP "av_undef" 8
.IX Xref "av_undef"
.IX Item "av_undef"
Undefines the array.  Frees the memory used by the array itself.
.Sp
.Vb 1
\&        void    av_undef(AV* ar)
.Ve
.IP "av_unshift" 8
.IX Xref "av_unshift"
.IX Item "av_unshift"
Unshift the given number of \f(CW\*(C`undef\*(C'\fR values onto the beginning of the
array.  The array will grow automatically to accommodate the addition.  You
must then use \f(CW\*(C`av_store\*(C'\fR to assign values to these new elements.
.Sp
.Vb 1
\&        void    av_unshift(AV* ar, I32 num)
.Ve
.IP "get_av" 8
.IX Xref "get_av"
.IX Item "get_av"
Returns the \s-1AV\s0 of the specified Perl array.  If \f(CW\*(C`create\*(C'\fR is set and the
Perl variable does not exist then it will be created.  If \f(CW\*(C`create\*(C'\fR is not
set and the variable does not exist then \s-1NULL\s0 is returned.
.Sp
\&\s-1NOTE:\s0 the perl_ form of this function is deprecated.
.Sp
.Vb 1
\&        AV*     get_av(const char* name, I32 create)