io.pkts.packet.sip.header

Interface ToHeader

All Superinterfaces:

AddressParametersHeader, Cloneable, HeaderAddress, Parameters, SipHeader

All Known Implementing Classes:

ToHeaderImpl

public interface ToHeader
extends AddressParametersHeader

Author:

jonas@jonasborjesson.com

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ToHeader.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static Buffer	COMPACT_NAME
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
ToHeader	clone()
ToHeader.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 ToHeader	frame(Buffer buffer) Frame the value as a ToHeader.
static Buffer	generateTag() Generate a new tag that can be used as a tag parameter for the ToHeader.
Buffer	getTag() Get the tag parameter.
default boolean	isToHeader()
default ToHeader	toToHeader()
static ToHeader.Builder	withAddress(Address address)
static ToHeader.Builder	withHost(Buffer host)
static ToHeader.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, isRouteHeader, isSubjectHeader, isSystemHeader, isViaHeader, toCallIdHeader, toContactHeader, toContentLengthHeader, toContentTypeHeader, toCSeqHeader, toExpiresHeader, toFromHeader, toMaxForwardsHeader, toRecordRouteHeader, toRouteHeader, toViaHeader, verify

Field Detail

NAME

static final Buffer NAME

COMPACT_NAME

static final Buffer COMPACT_NAME

Method Detail

getTag

Buffer getTag()
       throws SipParseException

Get the tag parameter.

Returns:

the tag or null if it hasn't been set.

Throws:

SipParseException - in case anything goes wrong while extracting tag.

clone

ToHeader clone()

Specified by:

clone in interface SipHeader

toToHeader

default ToHeader toToHeader()

Specified by:

toToHeader in interface SipHeader

frame

static ToHeader frame(Buffer buffer)
               throws SipParseException

Frame the value as a ToHeader. This method assumes that you have already parsed out the actual header name "To: ". Also, this method assumes that a message framer (or similar) has framed the buffer that is being passed in to us to only contain this header and nothing else. Note, as with all the frame-methods on all headers/messages/whatever, they do not do any validation that the information is actually correct. This method will simply only try and validate just enough to get the framing done.

Specified by:

frame in interface AddressParametersHeader

Specified by:

frame in interface SipHeader

Parameters:

value -

Returns:

Throws:

SipParseException - in case anything goes wrong while parsing.

generateTag

static Buffer generateTag()

Generate a new tag that can be used as a tag parameter for the ToHeader. A tag-parameter only has to be unique within the same Call-ID space so therefore it doesn't have to be cryptographically strong etc.

Returns:

isToHeader

default boolean isToHeader()

Specified by:

isToHeader in interface SipHeader

withHost

static ToHeader.Builder withHost(Buffer host)

withHost

static ToHeader.Builder withHost(String host)

withAddress

static ToHeader.Builder withAddress(Address address)
                             throws SipParseException

Throws:

SipParseException

copy

ToHeader.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: