io.sipstack.netty.codec.sip

Enum RawMessage.State

java.lang.Object

java.lang.Enum<RawMessage.State>

io.sipstack.netty.codec.sip.RawMessage.State

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<RawMessage.State>

Enclosing class:

RawMessage

public static enum RawMessage.State
extends java.lang.Enum<RawMessage.State>

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONSUME_COLON
CONSUME_DIGIT
CONSUME_LWS
EXPECT_COLON
GET_HEADERS Consume all headers.
GET_INITIAL_LINE While in this state, we will consume the initial line in the SIP message.
GET_PAYLOAD Once we have found the separator between the headers and the payload we will just blindly a byte at a time until we have read the entire payload.
INIT In the INIT state we will consume any CRLF we find.
IS_CONTENT_LENGTH_HEADER Whenever we encounter something that potentially could be the start of the Content-Length header we will enter this state.

Method Summary

Modifier and Type	Method and Description
static RawMessage.State	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static RawMessage.State[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INIT

public static final RawMessage.State INIT

In the INIT state we will consume any CRLF we find. This is allowed for stream based protocols according to RFC 3261.

GET_INITIAL_LINE

public static final RawMessage.State GET_INITIAL_LINE

While in this state, we will consume the initial line in the SIP message. We will not verify it is correct that is up to later stages of the processing.

GET_HEADERS

public static final RawMessage.State GET_HEADERS

Consume all headers. Apart from the Content-Length header we will in this state just seek to find the double CRLF indicating the separation between headers and potentially a body. The headers are merely just framed at this stage.

GET_PAYLOAD

public static final RawMessage.State GET_PAYLOAD

Once we have found the separator between the headers and the payload we will just blindly a byte at a time until we have read the entire payload. The length of the payload was discovered during the GET_HEADERS phase where we were not only just consuming all headers but we were looking for the Content-Length header as well.

IS_CONTENT_LENGTH_HEADER

public static final RawMessage.State IS_CONTENT_LENGTH_HEADER

Whenever we encounter something that potentially could be the start of the Content-Length header we will enter this state. While in this state, we will see if the next byte is the next expected byte in the token "Content-Length" (for the long version of the header name). If the next byte isn't what we expect, such in the case of e.g. Call-ID where we would bail on 'a' or Content-Type where we would eventually bail on the 'T', then we would once again move over to the state GET_HEADERS.

CONSUME_COLON

public static final RawMessage.State CONSUME_COLON

CONSUME_LWS

public static final RawMessage.State CONSUME_LWS

EXPECT_COLON

public static final RawMessage.State EXPECT_COLON

CONSUME_DIGIT

public static final RawMessage.State CONSUME_DIGIT

Method Detail

values

public static RawMessage.State[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RawMessage.State c : RawMessage.State.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RawMessage.State valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null