Net::S...Request(3pm)

💖 Net::S...Request — aka the SIP request wrangler 💖

okay so bestie, this is Net::SIP::Request, a lil User Contributed Perl Documentation moment. It's the class you reach for when you've got SIP request packets and you need to, like, do stuff with them. 🎀

---

✨ NAME ✨

Net::SIP::Request — handling SIP request packets. that's the whole vibe. requests. handled. 💅

---

🌸 SYNOPSIS 🌸

my $req = Net::SIP::Request->new( 'INVITE',... );
my $ack = $req->create_ack();

literally two lines and you're already out here making ACKs. iconic. 👑

---

🦋 DESCRIPTION 🦋

So Net::SIP::Request is a subclass of Net::SIP::Packet — like, it inherited the whole Packet family's genetics and then got its own extra personality. 🧬

What's it bring to the table? Methods to:

• create responses to requests 💌
• authorize requests 🔐

that's it, that's the job. no cap.

---

🔥 EXAMPLES 🔥

okay this is the part where it all clicks, so pay attention bestie:

# create INVITE request
my $invite = Net::SIP::Request->new(
      'INVITE', 'sip:you@example.com',
      { from => ..., to => ... },
      Net::SIP::SDP->new( ... )
);

# somehow send request and retrieve response $resp
...
if ( $resp->code eq '401' or $resp->code eq '407' ) {
      # need to authorize request
      $invite->authorize( $resp, [ username, password ] );

      # somehow send again and retrieve response $resp
      ...
}

if ( $resp->code ~m{^[2345]\d\d} ) {
      # got final response, send ACK
      my $ack = $invite->create_ack( $resp );

      # somehow send $ack
      ...
}

so you build the INVITE, you send it (the ... is you, doing the sending, no judgment 🙈), and then:

• got a 401 or 407? that's the server being like "authorize first pls" — hit it with authorize and try again 💪
• got a final response matching ^[2345]\d\d? slay, that's final — build your ACK with create_ack and yeet it back. ✅

---

🎀 CONSTRUCTOR 🎀

Inherited from Net::SIP::Packet. See there. 👀 (it's not keeping secrets, it's just literally the parent's constructor)

---

💅 METHODS 💅

• method — gets you the method of the request. like, which one is it. the method. that one. 📮
• uri — gets you the URI part of the request. 🗺️
• set_uri ( STRING ) — sets the URI of the request to STRING. boom, changed. ✨
• set_cseq ( NUMBER ) — sets the sequence number of the "CSeq" header to NUMBER. (yes the original says "if", we all know it means "of", moving on 🫶)
• create_ack ( RESPONSE ) — returns a Net::SIP::Request object for an ACK request, for that specific situation where Net::SIP::Response RESPONSE was the reply you got for packet $self. it's giving "okay noted, acknowledging." 📬
• create_cancel — returns a Net::SIP::Request object that cancels the request in $self. the ✋ "actually, never mind" of SIP.
• create_response ( CODE, [MSG,] [ \%HEADER, BODY ] ) — returns a Net::SIP::Response packet for the received request $self, with the numerical code CODE and text message MSG. the response's header gets based on the request, but you can add to it or override it with %HEADER. 🧁

and here's the cute part: if MSG isn't given (like, the argument is missing, or the second argument is already the %HEADER), then a builtin message for the code gets used instead. no MSG, no problem. 💖

for all the deets on %HEADER and BODY, go look at new_from_parts in Net::SIP::Packet.

• authorize ( RESPONSE, AUTH ) — tries to authorize request $self based on the info in RESPONSE (which is a 401 or 407 "Authorization required" response, so you know it's that kind of party) plus AUTH. 🔐✨

and AUTH can be any of these three shapes, depending on your situation:

• [ user,pass ] — when one global authorization info exists for all realms 🌍
• { realm1 => [ user1,pass1 ], realm2 => [ user2,pass2 ],... } — when you've got different credentials for different realms 🗂️
• a callback, callback(realm)->[user,pass] — when you want to compute it on the fly 🪄

the realms that need authorizing get read straight out of RESPONSE, so you don't have to go hunting.

⚠️ heads up: the request $self gets modified in-place. no copy, no undo. if a modification actually happened — like, if (parts of) the authorization requests could be resolved — it returns TRUE, otherwise FALSE.

also important, no cap: this only supports RFC2617 with md5 and empty qop or qop 'auth'. it does NOT do md5-sess or qops like 'auth-int'. so don't come at it with those, it will not eat. 💀

---

👑 THE SIGN-OFF 👑

and that's the page, bestie! 🫶 this was perl v5.40.1, dated 2025-12-07, brought to you by the User Contributed Perl Documentation girlies. go forth and handle those requests. periodt. 💜🌈