.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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::Redirect 3pm"
.TH Net::SIP::Redirect 3pm "2023-09-29" "perl v5.36.0" "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::Redirect \- Send redirect to Requests based on lookup at a registrar
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 5
\&  my $reg = Net::SIP::Registrar\->new(...);
\&  my $redir = Net::SIP::Redirect(
\&        dispatcher => $dispatcher,
\&        registrar => $reg,
\&  );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This package implements a simple redirection of Requests using the information
provided by a registrar.
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
.ie n .IP "new ( %ARGS )" 4
.el .IP "new ( \f(CW%ARGS\fR )" 4
.IX Item "new ( %ARGS )"
This creates a new redirect object, \f(CW%ARGS\fR can have the following keys:
.RS 4
.IP "dispatcher" 8
.IX Item "dispatcher"
Net::SIP::Dispatcher object managing the registar. Mandatory.
.IP "registrar" 8
.IX Item "registrar"
Registrar object. This is an object like a Net::SIP::Registrar, which
has a \f(CW\*(C`query(address)\*(C'\fR method which returns a list of contacts.
.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. Will return \f(CW\*(C`()\*(C'\fR and ignore the packet if it's
an \s-1REGISTER\s0 request.
.Sp
For Requests it will query the registrar and return either
\&\f(CW\*(C`302 Moved Temporarily\*(C'\fR with the list of contacts or
\&\f(CW\*(C`404 Not Found\*(C'\fR if the address is not registered.