.\" 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
.\" ========================================================================
.\"
.IX Title "Net::SIP::ReceiveChain 3pm"
.TH Net::SIP::ReceiveChain 3pm "2021-03-01" "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"
Net::SIP::ReceiveChain \- handle incoming packet by multiple receivers
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  # create proxy which works as a registrar too, but
\&  # all register requests should be authorized
\&
\&  my $registrar = Net::SIP::Registrar\->new...
\&  my $auth = Net::SIP::Authorize\->new ....
\&  my $reg_chain = Net::SIP::ReceiveChain\->new(
\&        [ $auth,$registrar ],
\&        methods => [ \*(AqREGISTER\*(Aq ],
\&  );
\&
\&  my $proxy = Net::SIP::StatelessProxy\->new...
\&  my $chain = Net::SIP::ReceiveChain\->new(
\&        [ $registrar,$proxy ]
\&  );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This package is used to handle incoming packets by multiple receivers,
e.g. make sure that requests for Net::SIP::Registrar will be
authorized by Net::SIP::Authorize.
.PP
Objects in the chain might be Net::SIP::Registrar, Net::SIP::StatelessProxy,
Net::SIP::Authorize, Net::SIP::ReceiveChain itself and
every other object which handles \f(CW\*(C`receive\*(C'\fR like described below.
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
.ie n .IP "new ( \s-1OBJECTS,\s0 %ARGS )" 4
.el .IP "new ( \s-1OBJECTS,\s0 \f(CW%ARGS\fR )" 4
.IX Item "new ( OBJECTS, %ARGS )"
This creates a new registar object, \s-1OBJECTS\s0 is a reference to an array of
objects implementing the \f(CW\*(C`receive\*(C'\fR method.
.Sp
\&\f(CW%ARGS\fR can have the following keys:
.RS 4
.IP "filter" 8
.IX Item "filter"
A callback which gets called during \f(CW\*(C`receive\*(C'\fR with all arguments of
the method. If it returns \s-1TRUE\s0 the packet will be handled by the
chain, otherwise not.
.IP "methods" 8
.IX Item "methods"
If \fBfilter\fR is not given but \fBmethods\fR is it will set \fBfilter\fR
to a callback which accepts only the methods specified in the
array reference given to \fBmethods\fR.
.RE
.RS 4
.RE
.SH "METHODS"
.IX Header "METHODS"
.IP "receive ( \s-1PACKET,LEG,FROM\s0 )" 4
.IX Item "receive ( PACKET,LEG,FROM )"
\&\s-1PACKET\s0 is the incoming packet,
\&\s-1LEG\s0 is the Net::SIP::Leg where the packet arrived and \s-1FROM\s0
is the \f(CW"ip:port"\fR of the sender. Responses will be send
back to the sender through the same leg.
.Sp
Called from the managing Net::SIP::Dispatcher object if a new
packet arrives.
.Sp
Returns \s-1TRUE\s0 if the packet was fully handled by one of the objects
in the chain, else \s-1FALSE:\s0
.RS 4
.IP "\(bu" 8
If a filter was given checks the packet against the filter and
returns \s-1FALSE\s0 if the filter does return \s-1FALSE.\s0
.IP "\(bu" 8
Otherwise it will call \f(CW\*(C`receive\*(C'\fR on all objects in the
chain until one of these returns \s-1TRUE.\s0 In this case it
will return \s-1TRUE.\s0
.IP "\(bu" 8
If no object in the chain handled the packet it will return \s-1FALSE.\s0
.RE
.RS 4
.RE