io.pkts.packet.sip.impl

Class ImmutableSipResponse

java.lang.Object

io.pkts.packet.sip.impl.ImmutableSipMessage

io.pkts.packet.sip.impl.ImmutableSipResponse

All Implemented Interfaces:

SipMessage, SipResponse, Cloneable

public class ImmutableSipResponse
extends ImmutableSipMessage
implements SipResponse

Author:

jonas@jonasborjesson.com

Nested Class Summary

Nested classes/interfaces inherited from interface io.pkts.packet.sip.SipResponse

SipResponse.Builder

Field Summary

Fields inherited from interface io.pkts.packet.sip.SipMessage

UNABLE_TO_PARSE_OUT_THE_METHOD_DUE_TO_UNDERLYING_IO_EXCEPTION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ImmutableSipResponse(Buffer message, SipResponseLine initialLine, List<SipHeader> headers, short indexOfTo, short indexOfFrom, short indexOfCSeq, short indexOfCallId, short indexOfMaxForwards, short indexOfVia, short indexOfRoute, short indexOfRecordRoute, short indexOfContact, Buffer body)

Method Summary

Modifier and Type	Method and Description
SipResponse	clone() Perform a deep clone of this SipMessage.
SipResponse.Builder	copy()
Buffer	getMethod() Get the method of this sip message
Buffer	getReasonPhrase() Get the reason phrase of this SipResponse
int	getStatus() Get the status code of this SIP response
ViaHeader	popViaHeader() Pop the top-most ViaHeader.

Methods inherited from class io.pkts.packet.sip.impl.ImmutableSipMessage

addHeader, addHeaderFirst, countNoOfHeaders, getAllHeaders, getCallIDHeader, getContactHeader, getContent, getContentLength, getContentTypeHeader, getCSeqHeader, getExpiresHeader, getFromHeader, getHeader, getHeader, getHeaders, getHeaders, getInitialLine, getInitialLineAsObject, getMaxForwards, getRecordRouteHeader, getRecordRouteHeaders, getRouteHeader, getRouteHeaders, getToHeader, getViaHeader, getViaHeaders, hasContent, initialLine, isInitial, popHeader, setHeader, toBuffer, toString, verify

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.pkts.packet.sip.SipResponse

is100Trying, isClientError, isError, isFinal, isGlobalError, isProvisional, isRedirect, isResponse, isRinging, isServerError, isSuccess, isTimeout, toResponse, withStatusCode

Methods inherited from interface io.pkts.packet.sip.SipMessage

addHeader, addHeaderFirst, countNoOfHeaders, createResponse, createResponse, frame, frame, frame, getAllHeaders, getCallIDHeader, getContactHeader, getContent, getContentLength, getContentTypeHeader, getCSeqHeader, getExpiresHeader, getFromHeader, getHeader, getHeader, getHeaders, getHeaders, getInitialLine, getMaxForwards, getRecordRouteHeader, getRecordRouteHeaders, getRouteHeader, getRouteHeaders, getToHeader, getViaHeader, getViaHeaders, hasContent, initialLine, isAck, isBye, isCancel, isInfo, isInitial, isInvite, isMessage, isOptions, isRegister, isRequest, isSubsequent, popHeader, setHeader, toBuffer, toRequest, verify

Constructor Detail

ImmutableSipResponse

protected ImmutableSipResponse(Buffer message,
                               SipResponseLine initialLine,
                               List<SipHeader> headers,
                               short indexOfTo,
                               short indexOfFrom,
                               short indexOfCSeq,
                               short indexOfCallId,
                               short indexOfMaxForwards,
                               short indexOfVia,
                               short indexOfRoute,
                               short indexOfRecordRoute,
                               short indexOfContact,
                               Buffer body)

Parameters:

message - the full immutable buffer which has the entire SIP message in it, including all headers, body initial line etc.

initialLine - the parsed initial line (which is just a reference into the message buffer)

headers -

indexOfTo -

indexOfFrom -

indexOfCSeq -

indexOfCallId -

indexOfMaxForwards -

indexOfVia -

indexOfRoute -

indexOfRecordRoute -

indexOfContact -

body -

Method Detail

getMethod

public Buffer getMethod()
                 throws SipParseException

Description copied from interface: SipMessage

Get the method of this sip message

Specified by:

getMethod in interface SipMessage

Returns:

Throws:

SipParseException

copy

public SipResponse.Builder copy()

Specified by:

copy in interface SipMessage

Specified by:

copy in interface SipResponse

getStatus

public int getStatus()

Description copied from interface: SipResponse

Get the status code of this SIP response

Specified by:

getStatus in interface SipResponse

Returns:

getReasonPhrase

public Buffer getReasonPhrase()

Description copied from interface: SipResponse

Get the reason phrase of this SipResponse

Specified by:

getReasonPhrase in interface SipResponse

Returns:

popViaHeader

public ViaHeader popViaHeader()
                       throws SipParseException

Description copied from interface: SipResponse

Pop the top-most ViaHeader.

This is a convenience method for calling SipMessage.popHeader(Buffer).

Specified by:

popViaHeader in interface SipResponse

Returns:

the top-most ViaHeader or null if this SipResponse contained no ViaHeaders.

Throws:

SipParseException

clone

public final SipResponse clone()

Description copied from interface: SipMessage

Perform a deep clone of this SipMessage.

Specified by:

clone in interface SipMessage

Specified by:

clone in interface SipResponse

Overrides:

clone in class ImmutableSipMessage

Returns: