io.pkts.packet.sip.header

Interface RouteHeader

All Superinterfaces:

AddressParametersHeader, Cloneable, HeaderAddress, Parameters, SipHeader

All Known Implementing Classes:

RouteHeaderImpl

public interface RouteHeader
extends AddressParametersHeader

Source: RFC 3261 section 20.30

The Route header field is used to force routing for a request through the listed set of proxies. Examples of the use of the Route header field are in Section 16.12.1.

Example:

    Route: <sip:bigbox3.site3.atlanta.com;lr>,
           <sip:server10.biloxi.com;lr>
 

Author:

[email protected]

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RouteHeader.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static Buffer	NAME

Fields inherited from interface io.pkts.packet.sip.header.SipHeader

CANNOT_CAST_HEADER_OF_TYPE, UNABLE_TO_PARSE_OUT_THE_HEADER_NAME_DUE_TO_UNDERLYING_IO_EXCEPTION

Method Summary

Modifier and Type	Method and Description
RouteHeader	clone()
RouteHeader.Builder	copy() Everything within the pkts.io SIP module are immutable so if you actually want to change anything you have to create a copy, which will return a specific Builder for that header.
static RouteHeader	frame(Buffer buffer) Frame the value as a RouteHeader.
default boolean	isRouteHeader()
default RouteHeader	toRouteHeader()
static RouteHeader.Builder	withAddress(Address address)
static RouteHeader.Builder	withHost(Buffer host)
static RouteHeader.Builder	withHost(String host)

Methods inherited from interface io.pkts.packet.sip.header.AddressParametersHeader

isAddressParametersHeader, toAddressParametersHeader, with

Methods inherited from interface io.pkts.packet.sip.header.HeaderAddress

getAddress

Methods inherited from interface io.pkts.packet.sip.header.Parameters

getParameter, getParameter, setParameter, setParameter

Methods inherited from interface io.pkts.packet.sip.header.SipHeader

create, ensure, frame, getBufferSize, getBytes, getName, getNameStr, getValue, is, is, isCallIdHeader, isContactHeader, isContentLengthHeader, isContentTypeHeader, isCSeqHeader, isExpiresHeader, isFromHeader, isMaxForwardsHeader, isRecordRouteHeader, isSubjectHeader, isSystemHeader, isToHeader, isViaHeader, toCallIdHeader, toContactHeader, toContentLengthHeader, toContentTypeHeader, toCSeqHeader, toExpiresHeader, toFromHeader, toMaxForwardsHeader, toRecordRouteHeader, toToHeader, toViaHeader, verify

Field Detail

NAME

static final Buffer NAME

Method Detail

clone

RouteHeader clone()

Specified by:

clone in interface SipHeader

frame

static RouteHeader frame(Buffer buffer)
                  throws SipParseException

Frame the value as a RouteHeader.

Specified by:

frame in interface AddressParametersHeader

Specified by:

frame in interface SipHeader

Parameters:

value -

Returns:

Throws:

SipParseException - in case anything goes wrong while parsing.

copy

RouteHeader.Builder copy()

Description copied from interface: SipHeader

Everything within the pkts.io SIP module are immutable so if you actually want to change anything you have to create a copy, which will return a specific Builder for that header.

Specified by:

copy in interface AddressParametersHeader

Specified by:

copy in interface SipHeader

Returns:

isRouteHeader

default boolean isRouteHeader()

Specified by:

isRouteHeader in interface SipHeader

toRouteHeader

default RouteHeader toRouteHeader()

Specified by:

toRouteHeader in interface SipHeader

withHost

static RouteHeader.Builder withHost(Buffer host)

withHost

static RouteHeader.Builder withHost(String host)

withAddress

static RouteHeader.Builder withAddress(Address address)
                                throws SipParseException

Throws:

SipParseException