io.pkts.packet.sip

Interface SipResponse

All Superinterfaces:

Cloneable, SipMessage

All Known Implementing Classes:

SipResponseImpl

public interface SipResponse
extends SipMessage

Author:

jonas@jonasborjesson.com

Method Summary

Modifier and Type	Method and Description
SipResponse	clone() Perform a deep clone of this SipMessage.
Buffer	getReasonPhrase() Get the reason phrase of this SipResponse
int	getStatus() Get the status code of this SIP response
boolean	is100Trying() Convenience method for checking whether this is a 100 Trying response or not.
boolean	isClientError() Convenience method for checking whether this is a 4xx response or not.
boolean	isFinal() Convenience method for checking whether this response is a final response, i.e.
boolean	isGlobalError() Convenience method for checking whether this is a 6xx response or not.
boolean	isProvisional() Convenience method for checking whether this is a 1xx response or not.
boolean	isRedirect() Convenience method for checking whether this is a 3xx response or not.
boolean	isRinging() Convenience method for checking whether this is a 180 Ringing response or or a 183 Early Media response.
boolean	isServerError() Convenience method for checking whether this is a 5xx response or not.
boolean	isSuccess() Convenience method for checking whether this is a 2xx response or not.
boolean	isTimeout() Convenience method for checking whether this is a 480 Timeout response or not.
ViaHeader	popViaHeader() Pop the top-most ViaHeader.

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

addHeader, addHeaderFirst, createResponse, frame, frame, getCallIDHeader, getContactHeader, getContent, getContentTypeHeader, getCSeqHeader, getExpiresHeader, getFromHeader, getHeader, getHeader, getInitialLine, getMaxForwards, getMethod, getRawContent, getRecordRouteHeader, getRecordRouteHeaders, getRouteHeader, getRouteHeaders, getToHeader, getViaHeader, getViaHeaders, hasContent, isAck, isBye, isCancel, isInfo, isInitial, isInvite, isMessage, isOptions, isRegister, isRequest, isResponse, popHeader, setHeader, toBuffer, toRequest, toResponse, verify

Method Detail

getStatus

int getStatus()

Get the status code of this SIP response

Returns:

getReasonPhrase

Buffer getReasonPhrase()

Get the reason phrase of this SipResponse

Returns:

isProvisional

boolean isProvisional()

Convenience method for checking whether this is a 1xx response or not.

Returns:

isFinal

boolean isFinal()

Convenience method for checking whether this response is a final response, i.e. any response >= 200.

Returns:

isSuccess

boolean isSuccess()

Convenience method for checking whether this is a 2xx response or not.

Returns:

isRedirect

boolean isRedirect()

Convenience method for checking whether this is a 3xx response or not.

Returns:

isClientError

boolean isClientError()

Convenience method for checking whether this is a 4xx response or not.

Returns:

isServerError

boolean isServerError()

Convenience method for checking whether this is a 5xx response or not.

Returns:

isGlobalError

boolean isGlobalError()

Convenience method for checking whether this is a 6xx response or not.

Returns:

is100Trying

boolean is100Trying()

Convenience method for checking whether this is a 100 Trying response or not.

Returns:

isRinging

boolean isRinging()

Convenience method for checking whether this is a 180 Ringing response or or a 183 Early Media response.

Returns:

true if this response is a 180 or a 183 response, false otherwise

isTimeout

boolean isTimeout()

Convenience method for checking whether this is a 480 Timeout response or not.

Returns:

popViaHeader

ViaHeader popViaHeader()
                throws SipParseException

Pop the top-most ViaHeader. This is a convenience method for calling SipMessage.popHeader(Buffer).

Returns:

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

Throws:

SipParseException

clone

SipResponse clone()

Description copied from interface: SipMessage

Perform a deep clone of this SipMessage.

Specified by:

clone in interface SipMessage

Returns: