| Package | Description |
|---|---|
| io.pkts.packet.sip | |
| io.pkts.packet.sip.address | |
| io.pkts.packet.sip.address.impl | |
| io.pkts.packet.sip.header | |
| io.pkts.packet.sip.header.impl | |
| io.pkts.packet.sip.impl |
| Modifier and Type | Method and Description |
|---|---|
static SipRequest.Builder |
SipRequest.ack(SipURI requestURI) |
static SipRequest.Builder |
SipRequest.ack(String requestURI) |
void |
SipMessage.addHeader(SipHeader header) |
void |
SipMessage.addHeaderFirst(SipHeader header) |
SipRequest |
SipRequest.Builder.build()
Build a new
SipRequest. |
static SipRequest.Builder |
SipRequest.cancel(SipURI requestURI) |
static SipRequest.Builder |
SipRequest.cancel(String requestURI) |
SipResponse |
SipMessage.createResponse(int responseCode)
Create a new response based on this
SipRequest. |
static SipMessage |
SipMessage.frame(Buffer buffer)
Frame the supplied buffer into a
SipMessage. |
static SipMessage |
SipMessage.frame(String buffer) |
CallIdHeader |
SipMessage.getCallIDHeader()
Convenience method for fetching the call-id-header
|
ContactHeader |
SipMessage.getContactHeader()
Get the
ContactHeader |
Object |
SipMessage.getContent()
Returns the content (payload) of the
SipMessage as an
Object. |
ContentTypeHeader |
SipMessage.getContentTypeHeader()
Get the
ContentTypeHeader for this message. |
CSeqHeader |
SipMessage.getCSeqHeader()
Convenience method for fetching the CSeq header
|
ExpiresHeader |
SipMessage.getExpiresHeader()
Get the
ExpiresHeader |
FromHeader |
SipMessage.getFromHeader()
Convenience method for fetching the from-header
|
SipHeader |
SipMessage.getHeader(Buffer headerName)
Get the header as a buffer
|
SipHeader |
SipMessage.getHeader(String headerName)
Same as
#getHeader(Buffers.wrap(keyParameter). |
MaxForwardsHeader |
SipMessage.getMaxForwards() |
Buffer |
SipMessage.getMethod()
Get the method of this sip message
|
RecordRouteHeader |
SipMessage.getRecordRouteHeader()
Get the top-most
RecordRouteHeader header if present. |
List<RecordRouteHeader> |
SipMessage.getRecordRouteHeaders()
Get all the RecordRoute-headers in this
SipMessage. |
URI |
SipRequest.getRequestUri()
Get the request uri of the sip request
|
RouteHeader |
SipMessage.getRouteHeader()
Get the top-most
RouteHeader header if present. |
List<RouteHeader> |
SipMessage.getRouteHeaders()
Get all the Route-headers in this
SipMessage. |
ToHeader |
SipMessage.getToHeader()
Convenience method for fetching the to-header
|
ViaHeader |
SipMessage.getViaHeader()
Get the top-most
ViaHeader if present. |
List<ViaHeader> |
SipMessage.getViaHeaders()
Get all the Via-headers in this
SipMessage. |
static SipRequest.Builder |
SipRequest.invite(String requestURI)
Factory method for creating a new INVITE request builder.
|
boolean |
SipMessage.isAck()
Convenience method for determining whether the method of this message is
an ACK or not.
|
boolean |
SipMessage.isBye()
Convenience method for determining whether the method of this message is a BYE or not.
|
boolean |
SipMessage.isCancel()
Convenience method for determining whether the method of this message is
a CANCEL or not
|
boolean |
SipMessage.isInfo()
Convenience method for determining whether the method of this message is
a INFO or not.
|
boolean |
SipMessage.isInitial()
Checks whether or not this request is considered to be an "initial"
request, i.e., a request that does not go within a dialog.
|
boolean |
SipMessage.isInvite()
Convenience method for determining whether the method of this message is
an INVITE or not.
|
boolean |
SipMessage.isMessage()
Convenience method for determining whether the method of this message is
a MESSAGE or not.
|
boolean |
SipMessage.isOptions()
Convenience method for determining whether the method of this message is
a OPTIONS or not.
|
boolean |
SipMessage.isRegister()
Convenience method for determining whether the method of this message is an REGISTER or not.
|
SipHeader |
SipMessage.popHeader(Buffer headerNme)
Remove and return the top-most header.
|
ViaHeader |
SipResponse.popViaHeader()
Pop the top-most
ViaHeader. |
static SipRequest.Builder |
SipRequest.request(Buffer method,
String requestURI) |
void |
SipMessage.setHeader(SipHeader header)
Set the specified header, which will replace the existing header of the
same name.
|
| Modifier and Type | Method and Description |
|---|---|
Address |
Address.AddressBuilder.build() |
SipURI |
SipURI.Builder.build()
Construct a
SipURI. |
static URI |
URI.frame(Buffer buffer) |
static SipURI |
SipURI.frame(Buffer buffer)
Frame a sip or sips-uri, which according to RFC3261 is:
|
Buffer |
SipURI.getMAddrParam()
Get the maddr parameter.
|
Buffer |
SipURI.getMethodParam()
Get the method parameter.
|
Buffer |
SipURI.getParameter(Buffer name)
Get the value of the named parameter.
|
Buffer |
SipURI.getParameter(String name)
Same as
SipURI.getParameter(Buffer). |
Buffer |
SipURI.getTransportParam()
Same as
#getParameter("transport") |
int |
SipURI.getTTLParam()
Get the ttl parameter.
|
URI |
Address.getURI()
|
Buffer |
SipURI.getUserParam()
Get the user parameter.
|
SipURI.Builder |
SipURI.Builder.host(Buffer host)
Specify the host.
|
SipURI.Builder |
SipURI.Builder.host(String host) |
SipURI.Builder |
SipURI.Builder.parameter(Buffer name,
Buffer value) |
SipURI.Builder |
SipURI.Builder.parameter(String name,
String value) |
SipURI.Builder |
SipURI.Builder.port(int port)
Set the port.
|
void |
SipURI.setParameter(Buffer name,
Buffer value)
Sets the value of the specified parameter.
|
void |
SipURI.setParameter(Buffer name,
int value) |
void |
SipURI.setParameter(String name,
int value) |
void |
SipURI.setParameter(String name,
String value) |
SipURI.Builder |
SipURI.Builder.transport(Buffer transport) |
SipURI.Builder |
SipURI.Builder.transport(String transport) |
| Modifier and Type | Method and Description |
|---|---|
Buffer |
SipURIImpl.getMAddrParam() |
Buffer |
SipURIImpl.getMethodParam() |
Buffer |
SipURIImpl.getParameter(Buffer name) |
Buffer |
SipURIImpl.getParameter(String name) |
Buffer |
SipURIImpl.getTransportParam() |
int |
SipURIImpl.getTTLParam() |
URI |
AddressImpl.getURI() |
Buffer |
SipURIImpl.getUserParam() |
static Address |
AddressImpl.parse(Buffer buffer)
Parses a SIP "name-addr" as defined by RFC3261 section 25.1:
|
void |
SipURIImpl.setParameter(Buffer name,
Buffer value) |
void |
SipURIImpl.setParameter(Buffer name,
int value) |
void |
SipURIImpl.setParameter(String name,
int value) |
void |
SipURIImpl.setParameter(String name,
String value) |
| Modifier and Type | Method and Description |
|---|---|
T |
AddressParametersHeader.Builder.build()
Build a new ToHeader.
|
ViaHeader |
ViaHeader.ViaHeaderBuilder.build() |
CSeqHeader.CSeqHeaderBuilder |
CSeqHeader.CSeqHeaderBuilder.cseq(long cseq) |
static MaxForwardsHeader |
MaxForwardsHeader.frame(Buffer buffer) |
static Object[] |
AddressParametersHeader.frame(Buffer buffer)
Frame the value as a
AddressParametersHeaderImpl. |
static FromHeader |
FromHeader.frame(Buffer buffer)
Frame the value as a
FromHeader. |
static ExpiresHeader |
ExpiresHeader.frame(Buffer buffer) |
static CSeqHeader |
CSeqHeader.frame(Buffer value)
Parse the value as a cseq value.
|
static ContentTypeHeader |
ContentTypeHeader.frame(Buffer buffer)
Frame the value as a
ContentTypeHeader. |
static RouteHeader |
RouteHeader.frame(Buffer buffer)
Frame the value as a
RouteHeader. |
static SipHeader |
SipHeader.frame(Buffer value)
Create a new
SipHeader based on the buffer. |
static ToHeader |
ToHeader.frame(Buffer buffer)
Frame the value as a
ToHeader. |
static ContactHeader |
ContactHeader.frame(Buffer buffer)
Frame the value as a
ContactHeader. |
static RecordRouteHeader |
RecordRouteHeader.frame(Buffer buffer)
Frame the value as a
RecordRouteHeader. |
static ViaHeader |
ViaHeader.frame(Buffer buffer)
Frame a buffer into a
ViaHeader. |
static Buffer[] |
MediaTypeHeader.frame(Buffer buffer)
Convenience method for parsing out a media type header.
|
static CallIdHeader |
CallIdHeader.frameCompact(Buffer buffer)
Frame the
CallIdHeader using its compact name. |
Buffer |
Parameters.getParameter(Buffer name)
Get the value of the named parameter.
|
Buffer |
Parameters.getParameter(String name)
Same as
Parameters.getParameter(Buffer). |
Buffer |
FromHeader.getTag()
Get the tag parameter.
|
Buffer |
ToHeader.getTag()
Get the tag parameter.
|
FromHeader |
FromHeader.Builder.internalBuild(Address address,
Buffer params) |
ToHeader |
ToHeader.Builder.internalBuild(Address address,
Buffer params) |
ContactHeader |
ContactHeader.Builder.internalBuild(Address address,
Buffer params) |
CSeqHeader.CSeqHeaderBuilder |
CSeqHeader.CSeqHeaderBuilder.method(Buffer method) |
CSeqHeader.CSeqHeaderBuilder |
CSeqHeader.CSeqHeaderBuilder.method(String method) |
AddressParametersHeader.Builder<T> |
AddressParametersHeader.Builder.parameter(Buffer name,
Buffer value)
Set a parameter on the header.
|
AddressParametersHeader.Builder<T> |
AddressParametersHeader.Builder.parameter(String name,
String value) |
void |
Parameters.setParameter(Buffer name,
Buffer value)
Sets the value of the specified parameter.
|
void |
Parameters.setParameter(Buffer name,
java.util.function.Supplier<Buffer> value) |
ViaHeader.ViaHeaderBuilder |
ViaHeader.ViaHeaderBuilder.transport(Buffer transport)
Set the transport.
|
ViaHeader.ViaHeaderBuilder |
ViaHeader.ViaHeaderBuilder.transport(String transport) |
AddressParametersHeader.Builder<T> |
AddressParametersHeader.Builder.transportSCTP()
Set the transport parameter on the underlying
SipURI to be "sctp". |
AddressParametersHeader.Builder<T> |
AddressParametersHeader.Builder.transportTCP()
Set the transport parameter on the underlying
SipURI to be "tcp". |
AddressParametersHeader.Builder<T> |
AddressParametersHeader.Builder.transportTLS()
Set the transport parameter on the underlying
SipURI to be "tls". |
AddressParametersHeader.Builder<T> |
AddressParametersHeader.Builder.transportUDP()
Set the transport parameter on the underlying
SipURI to be "udp". |
AddressParametersHeader.Builder<T> |
AddressParametersHeader.Builder.transportWS()
Set the transport parameter on the underlying
SipURI to be "ws". |
AddressParametersHeader.Builder<T> |
AddressParametersHeader.Builder.uriParameter(Buffer name,
Buffer value)
Set a parameter on the underlying
SipURI. |
AddressParametersHeader.Builder<T> |
AddressParametersHeader.Builder.uriParameter(String name,
String value)
Set a parameter on the underlying
SipURI. |
void |
SipHeader.verify() |
static FromHeader.Builder |
FromHeader.with(Address address) |
static ToHeader.Builder |
ToHeader.with(Address address) |
static ContactHeader.Builder |
ContactHeader.with(Address address) |
static <T> AddressParametersHeader.Builder<AddressParametersHeader> |
AddressParametersHeader.with(Buffer headerName) |
static ContactHeader.Builder |
ContactHeader.with(SipURI uri) |
| Modifier and Type | Method and Description |
|---|---|
Buffer |
ViaHeaderImpl.getParameter(Buffer name)
Get the value of the named parameter.
|
Buffer |
ParametersImpl.getParameter(Buffer name) |
Buffer |
ParametersSupport.getParameter(Buffer name) |
Buffer |
ViaHeaderImpl.getParameter(String name)
Same as
Parameters.getParameter(Buffer). |
Buffer |
ParametersImpl.getParameter(String name) |
Buffer |
ParametersSupport.getParameter(String name) |
Buffer |
FromHeaderImpl.getTag()
Get the tag parameter.
|
Buffer |
ToHeaderImpl.getTag()
Get the tag parameter.
|
void |
ViaHeaderImpl.setParameter(Buffer name,
Buffer value) |
void |
ParametersImpl.setParameter(Buffer name,
Buffer value) |
void |
ParametersSupport.setParameter(Buffer name,
Buffer value) |
void |
ViaHeaderImpl.setParameter(Buffer name,
java.util.function.Supplier<Buffer> value) |
void |
ParametersImpl.setParameter(Buffer name,
java.util.function.Supplier<Buffer> value) |
void |
ParametersSupport.setParameter(String name,
String value) |
void |
SipHeaderImpl.verify() |
void |
ViaHeaderImpl.verify()
For a Via-header make sure that the branch parameter is present.
|
| Modifier and Type | Method and Description |
|---|---|
void |
SipMessageImpl.addHeaderFirst(SipHeader header) |
static void |
PreConditions.assertArgument(boolean expression,
String msg) |
static Buffer |
PreConditions.assertNotEmpty(Buffer reference,
String msg)
Assert that the
Buffer is not null nor empty. |
static String |
PreConditions.assertNotEmpty(String reference,
String msg) |
static <T> T |
PreConditions.assertNotNull(T reference) |
static <T> T |
PreConditions.assertNotNull(T reference,
String msg) |
static Buffer |
SipParser.consumeAddressSpec(Buffer buffer)
Consumes addr-spec, which according to RFC3261 section 25.1 is:
|
static int |
SipParser.consumeCOLON(Buffer buffer)
Consume colon (COLON), which according to RFC3261 section 25.1 Basic
Rules is:
COLON = SWS ":" SWS ; colon
|
static int |
SipParser.consumeCOMMA(Buffer buffer)
Consume comma (COMMA), which according to RFC3261 section 25.1 Basic
Rules is:
COMMA = SWS "," SWS ; comma
|
static int |
SipParser.consumeCRLF(Buffer buffer)
Consume CR + LF
|
static Buffer |
SipParser.consumeDisplayName(Buffer buffer)
The display name in SIP is a little tricky since it may or may not be
there and the stuff following it (whether or not it was there to begin
with) can easily be confused with being a display name.
|
static int |
SipParser.consumeLDQUOT(Buffer buffer)
Consume open double quotation mark (LDQUT), which according to RFC3261
section 25.1 Basic Rules is:
LDQUOT = SWS DQUOTE; open double quotation mark
|
static int |
SipParser.consumeLWS(Buffer buffer)
Consume linear whitespace (LWS), which according to RFC3261 section 25.1
Basic Rules is:
LWS = [*WSP CRLF] 1*WSP ; linear whitespace
|
static Buffer |
SipParser.consumeMSubtype(Buffer buffer)
Consume a m-subtype, which according to RFC3261 section 25.1 Basic Rules
is:
|
static Buffer |
SipParser.consumeMType(Buffer buffer)
Consume a m-type, which according to RFC3261 section 25.1 Basic Rules is:
|
static Buffer |
SipParser.consumeQuotedString(Buffer buffer)
Consumes a quoted-string, which is defined as:
|
static int |
SipParser.consumeRDQUOT(Buffer buffer)
Consume close double quotation mark (RDQUT), which according to RFC3261
section 25.1 Basic Rules is:
RDQUOT = DQUOTE SWS ; close double quotation mark
|
static int |
SipParser.consumeSEMI(Buffer buffer)
Consume semicolon (SEMI), which according to RFC3261 section 25.1 Basic
Rules is:
SEMI = SWS ";" SWS ; semicolon
|
static Buffer[] |
SipParser.consumeSentBye(Buffer buffer)
Consume a sent-by which according to 3261 is:
|
static Buffer |
SipParser.consumeSentProtocol(Buffer buffer)
Consume the "sent-protocol", which according to RFC 3261 is:
|
static int |
SipParser.consumeSLASH(Buffer buffer)
Consume an slash (SLASH), which according to RFC3261 section 25.1 Basic
Rules is:
SLASH = SWS "/" SWS ; slash
|
static int |
SipParser.consumeSTAR(Buffer buffer)
Consume an asterisk/star (STAR), which according to RFC3261 section 25.1
Basic Rules is:
STAR = SWS "*" SWS ; asterisk
|
static Buffer[] |
SipParser.consumeUserInfoHostPort(Buffer buffer)
Consume the userinfo and hostport.
|
static Object[] |
SipParser.consumeVia(Buffer buffer)
Consume a Via-header, which according to RFC3261 is:
|
static int |
SipParser.consumeWS(Buffer buffer)
Consume all the whitespace we find (WS)
|
SipResponse |
SipRequestImpl.createResponse(int statusCode)
Create a new response based on this
SipRequest. |
SipResponse |
SipMessageImpl.createResponse(int responseCode) |
static void |
SipParser.expect(Buffer buffer,
byte expected)
Check so that the next byte in the passed in buffer is the expected one.
|
static void |
SipParser.expect(Buffer buffer,
char ch)
Check so that the next byte in the passed in buffer is the expected one.
|
static Buffer |
SipParser.expectDigit(Buffer buffer)
Will expect at least 1 digit and will continue consuming bytes until a
non-digit is encountered
|
static int |
SipParser.expectHCOLON(Buffer buffer)
Convenience method for expecting (and consuming) a HCOLON, which is
defined as:
HCOLON = *( SP / HTAB ) ":" SWS
See RFC3261 section 25.1 Basic Rules
|
static void |
SipParser.expectSIP2_0(Buffer buffer)
Expect that the next set of bytes is "SIP/2.0" and if not then we will
throw a
SipParseException |
static void |
SipParser.expectSLASH(Buffer buffer)
Convenience method for expecting (and consuming) a SLASH, which is
defined as:
See RFC3261 section 25.1 Basic Rules
|
static Buffer |
SipParser.expectToken(Buffer buffer)
Expects a token, which according to RFC3261 section 25.1 Basic Rules is:
token = 1*(alphanum / "-" / "." / "!" / "%" / "*" / "_" / "+" / "`" / "'"
/ "~" )
|
static int |
SipParser.expectWS(Buffer buffer)
Expect the next byte to be a white space
|
CallIdHeader |
SipMessageImpl.getCallIDHeader()
Convenience method for fetching the call-id-header
|
ContactHeader |
SipMessageImpl.getContactHeader()
Get the
ContactHeader |
Object |
SipMessageImpl.getContent() |
ContentTypeHeader |
SipMessageImpl.getContentTypeHeader() |
CSeqHeader |
SipMessageImpl.getCSeqHeader() |
ExpiresHeader |
SipMessageImpl.getExpiresHeader()
Get the
ExpiresHeader |
FromHeader |
SipMessageImpl.getFromHeader()
Convenience method for fetching the from-header
|
SipHeader |
SipMessageImpl.getHeader(Buffer headerName)
Get the header as a buffer
|
SipHeader |
SipMessageImpl.getHeader(String headerName)
Same as
#getHeader(Buffers.wrap(keyParameter). |
MaxForwardsHeader |
SipMessageImpl.getMaxForwards() |
abstract Buffer |
SipMessageImpl.getMethod()
Get the method of this sip message
|
Buffer |
SipResponseImpl.getMethod()
Get the method of this sip message
|
RecordRouteHeader |
SipMessageImpl.getRecordRouteHeader()
Get the top-most
RecordRouteHeader header if present. |
List<RecordRouteHeader> |
SipMessageImpl.getRecordRouteHeaders() |
protected SipRequestLine |
SipMessageImpl.getRequestLine()
Since everything is done lazily, this method will parse and return the
initial line as a
SipRequestLine. |
URI |
SipRequestImpl.getRequestUri()
Get the request uri of the sip request
|
URI |
SipRequestLine.getRequestUri() |
protected SipResponseLine |
SipMessageImpl.getResponseLine()
Same as
SipMessageImpl.getRequestLine() but for SipResponseLine
instead. |
RouteHeader |
SipMessageImpl.getRouteHeader()
Get the top-most
RouteHeader header if present. |
List<RouteHeader> |
SipMessageImpl.getRouteHeaders() |
ToHeader |
SipMessageImpl.getToHeader()
Convenience method for fetching the to-header
|
ViaHeader |
SipMessageImpl.getViaHeader()
Get the top-most
ViaHeader if present. |
List<ViaHeader> |
SipMessageImpl.getViaHeaders() |
boolean |
SipMessageImpl.isAck()
Convenience method for determining whether the method of this message is
an ACK or not.
|
boolean |
SipMessageImpl.isBye()
Convenience method for determining whether the method of this message is a BYE or not.
|
boolean |
SipMessageImpl.isCancel()
Convenience method for determining whether the method of this message is
a CANCEL or not
|
boolean |
SipMessageImpl.isInfo() |
boolean |
SipMessageImpl.isInitial()
Checks whether or not this request is considered to be an "initial"
request, i.e., a request that does not go within a dialog.
|
boolean |
SipMessageImpl.isInvite()
Convenience method for determining whether the method of this message is
an INVITE or not.
|
boolean |
SipMessageImpl.isMessage() |
boolean |
SipMessageImpl.isOptions() |
boolean |
SipMessageImpl.isRegister()
Convenience method for determining whether the method of this message is an REGISTER or not.
|
static boolean |
SipParser.isSips(Buffer buffer) |
static SipHeader |
SipParser.nextHeader(Buffer buffer)
Get the next header, which may actually be returning multiple if there
are multiple headers on the same line.
|
static List<SipHeader> |
SipParser.nextHeaders(Buffer buffer) |
static SipInitialLine |
SipInitialLine.parse(Buffer buffer)
Parse the buffer into a SIP initial line, which either can be a
SipRequestLine or a SipResponseLine. |
SipHeader |
SipMessageImpl.popHeader(Buffer headerName) |
ViaHeader |
SipResponseImpl.popViaHeader() |
void |
SipMessageImpl.setHeader(SipHeader header) |
Copyright © 2017. All Rights Reserved.