io.pkts.packet.sip

Interface SipResponse

All Superinterfaces:

Cloneable, SipMessage

All Known Implementing Classes:

ImmutableSipResponse

public interface SipResponse
extends SipMessage

Author:

jonas@jonasborjesson.com

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SipResponse.Builder

Field Summary

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

UNABLE_TO_PARSE_OUT_THE_METHOD_DUE_TO_UNDERLYING_IO_EXCEPTION

Method Summary

Modifier and Type	Method and Description
SipResponse	clone() Perform a deep clone of this SipMessage.
SipResponse.Builder	copy()
Buffer	getReasonPhrase() Get the reason phrase of this SipResponse
int	getStatus() Get the status code of this SIP response
default boolean	is100Trying() Convenience method for checking whether this is a 100 Trying response or not.
default boolean	isClientError() Convenience method for checking whether this is a 4xx response or not.
default boolean	isError() Convenience method for checking whether this response is >= 400.
default boolean	isFinal() Convenience method for checking whether this response is a final response, i.e.
default boolean	isGlobalError() Convenience method for checking whether this is a 6xx response or not.
default boolean	isProvisional() Convenience method for checking whether this is a 1xx response or not.
default boolean	isRedirect() Convenience method for checking whether this is a 3xx response or not.
default boolean	isResponse() Check whether this sip message is a response or not
default boolean	isRinging() Convenience method for checking whether this is a 180 Ringing response or or a 183 Early Media response.
default boolean	isServerError() Convenience method for checking whether this is a 5xx response or not.
default boolean	isSuccess() Convenience method for checking whether this is a 2xx response or not.
default boolean	isTimeout() Convenience method for checking whether this is a 480 Timeout response or not.
default ViaHeader	popViaHeader() Pop the top-most ViaHeader.
default SipResponse	toResponse() Got tired of casting the SipMessage into a SipResponse so you can use this method instead.
static SipResponse.Builder	withStatusCode(int statusCode)

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, getMethod, 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

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:

isResponse

default boolean isResponse()

Description copied from interface: SipMessage

Check whether this sip message is a response or not

Specified by:

isResponse in interface SipMessage

Returns:

isError

default boolean isError()

Convenience method for checking whether this response is >= 400.

Returns:

isProvisional

default boolean isProvisional()

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

Returns:

isFinal

default boolean isFinal()

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

Returns:

isSuccess

default boolean isSuccess()

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

Returns:

isRedirect

default boolean isRedirect()

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

Returns:

isClientError

default boolean isClientError()

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

Returns:

isServerError

default boolean isServerError()

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

Returns:

isGlobalError

default boolean isGlobalError()

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

Returns:

is100Trying

default boolean is100Trying()

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

Returns:

isRinging

default 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

withStatusCode

static SipResponse.Builder withStatusCode(int statusCode)

isTimeout

default boolean isTimeout()

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

Returns:

toResponse

default SipResponse toResponse()
                        throws ClassCastException

Description copied from interface: SipMessage

Got tired of casting the SipMessage into a SipResponse so you can use this method instead. Just a short cut for: (SipResponse)sipMessage;

Specified by:

toResponse in interface SipMessage

Returns:

this but casted into a SipResponse

Throws:

ClassCastException - in case this SipMessage is actually a SipResponse.

popViaHeader

default 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

copy

SipResponse.Builder copy()

Specified by:

copy in interface SipMessage

clone

SipResponse clone()

Description copied from interface: SipMessage

Perform a deep clone of this SipMessage.

Specified by:

clone in interface SipMessage

Returns: