0x1949 Team - FAZEMRX - MANAGER

Edit File: Net::SIP::Blocker.3pm

.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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::Blocker 3pm"
.TH Net::SIP::Blocker 3pm "2021-05-04" "perl v5.34.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::Blocker \- blocks SIP requests based on method name
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 4
\&  my $block = Net::SIP::Blocker\->new(
\&          block => { \*(AqSUBSCRIBE\*(Aq => 405, \*(Aq...\*(Aq => ... },
\&          dispatcher => $disp,
\&  );
\&
\&  my $chain = Net::SIP::ReceiveChain\->new(
\&          [ $block, ... ]
\&  );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Blocks incoming requests by method name and sends back custom
error message.
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
.IP "new ( \s-1BLOCK,DISPATCHER\s0 )" 4
.IX Item "new ( BLOCK,DISPATCHER )"
Returns a new blocking object to be used in the chain.
.Sp
\&\s-1BLOCK\s0 is a hash reference where the keys are the methods to be blocked and
their values are the reason why the method was blocked. The reason
is the three digit code, optionally followed by a text.
.Sp
\&\s-1DISPATCHER\s0 is a Net::SIP::Dispatcher object.
.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.