io.pkts.packet.sip.header

Interface CallIdHeader

All Superinterfaces:

Cloneable, SipHeader

All Known Implementing Classes:

CallIdHeaderImpl

public interface CallIdHeader
extends SipHeader

Author:

jonas@jonasborjesson.com

Nested Class Summary

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

SipHeader.Builder<H extends SipHeader>

Field Summary

Fields

Modifier and Type	Field and Description
static Buffer	COMPACT_NAME The compact name of the Call-ID header is 'i'
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
CallIdHeader	clone()
static CallIdHeader	create()
static CallIdHeader	frame(Buffer buffer) Create a new SipHeader based on the buffer.
static CallIdHeader	frameCompact(Buffer buffer) Frame the CallIdHeader using its compact name.
Buffer	getCallId()
default boolean	isCallIdHeader()
default CallIdHeader	toCallIdHeader()

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

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

Field Detail

NAME

static final Buffer NAME

COMPACT_NAME

static final Buffer COMPACT_NAME

The compact name of the Call-ID header is 'i'

Method Detail

getCallId

Buffer getCallId()

clone

CallIdHeader clone()

Specified by:

clone in interface SipHeader

isCallIdHeader

default boolean isCallIdHeader()

Specified by:

isCallIdHeader in interface SipHeader

toCallIdHeader

default CallIdHeader toCallIdHeader()

Specified by:

toCallIdHeader in interface SipHeader

frame

static CallIdHeader frame(Buffer buffer)

Description copied from interface: SipHeader

Create a new SipHeader based on the buffer. Each SipHeader will override this factory method to parse the header into a more specialized header. Note, the header returned really is a SipHeader and is NOT e.g. a ToHeader. If you really need to parse it as a ToHeader you should use the

Specified by:

frame in interface SipHeader

Returns:

a new SipHeader.

frameCompact

static CallIdHeader frameCompact(Buffer buffer)
                          throws SipParseException

Frame the CallIdHeader using its compact name.

Parameters:

compactForm -

buffer -

Returns:

Throws:

SipParseException

create

static CallIdHeader create()