io.sipstack.netty.codec.sip

Class RawMessage

java.lang.Object

io.sipstack.netty.codec.sip.RawMessage

public final class RawMessage
extends java.lang.Object

Represents a raw sip message coming off of the network.

Author:

[email protected]

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RawMessage.State

Field Summary

Fields

Modifier and Type	Field and Description
static byte	COLON
static byte	CR
static byte	HTAB
static byte	LF
static byte	SP

Constructor Summary

Constructors

Constructor and Description
RawMessage(int maxAllowedInitialLineSize, int maxAllowedHeaderSize, int maxAllowedContentLength) Creates a new holder for a raw SIP message.

Method Summary

Modifier and Type	Method and Description
int	getContentLength() Get the content length of this message.
io.pkts.buffer.Buffer	getHeaders() Get all the raw headers of this message
io.pkts.buffer.Buffer	getInitialLine() Get the initial line of this raw message.
io.pkts.buffer.Buffer	getPayload() Get the payload of this raw message.
int	getPayloadWriteIndex() For stream based protocols there could be another message coming directly after this one so you just cant read until the ChannelBuffer runs out of bytes.
boolean	isComplete()
static boolean	isDigit(byte b)
static boolean	isDigit(char ch)
boolean	payloadCompleted() Check whether we have read the entire payload.
void	setContentLength(int contentLength) Set the expected content length of this message.
java.lang.String	toString()
void	write(byte b)
void	writeToHeaders(byte b) Write a byte to the header section of this raw message.
void	writeToInitialLine(byte b) Write a byte to the initial line.
void	writeToPayload(byte b) Write the next byte to the payload section of this message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

COLON

public static final byte COLON

See Also:

Constant Field Values

CR

public static final byte CR

See Also:

Constant Field Values

LF

public static final byte LF

See Also:

Constant Field Values

SP

public static final byte SP

See Also:

Constant Field Values

HTAB

public static final byte HTAB

See Also:

Constant Field Values

Constructor Detail

RawMessage

public RawMessage(int maxAllowedInitialLineSize,
                  int maxAllowedHeaderSize,
                  int maxAllowedContentLength)

Creates a new holder for a raw SIP message.

Parameters:

maxAllowedInitialLineSize - the maximum allowed size (in bytes) of the initial line.

maxAllowedHeaderSize - the maximum allowed size (in bytes) of all the headers combined.

maxAllowedContentLength - the maximum allowed size (in bytes) of the payload of the message.

Method Detail

write

public void write(byte b)
           throws MaxMessageSizeExceededException,
                  java.io.IOException

Throws:

MaxMessageSizeExceededException

java.io.IOException

isDigit

public static boolean isDigit(char ch)

isDigit

public static boolean isDigit(byte b)

isComplete

public boolean isComplete()

getInitialLine

public io.pkts.buffer.Buffer getInitialLine()

Get the initial line of this raw message.

Returns:

writeToInitialLine

public void writeToInitialLine(byte b)
                        throws MaxMessageSizeExceededException

Write a byte to the initial line. if the operation succeeds, true will be returned but if we hit the maximum allocated length of the initial line, then we will return false. The reason for this upper boundary is that you don't want an attacker to have you look for the initial line forever so once we hit our maximum allowed size of the initial line we will give up and the connection should be dropped.

Parameters:

b -

Throws:

MaxMessageSizeExceededException

getHeaders

public io.pkts.buffer.Buffer getHeaders()

Get all the raw headers of this message

Returns:

writeToHeaders

public void writeToHeaders(byte b)
                    throws MaxMessageSizeExceededException

Write a byte to the header section of this raw message.

Parameters:

b - the byte to write

Throws:

MaxMessageSizeExceededException

getPayload

public io.pkts.buffer.Buffer getPayload()

Get the payload of this raw message.

Returns:

the payload or null if there is no payload.

writeToPayload

public void writeToPayload(byte b)
                    throws MaxMessageSizeExceededException

Write the next byte to the payload section of this message.

Parameters:

b -

Throws:

MaxMessageSizeExceededException

getPayloadWriteIndex

public int getPayloadWriteIndex()

For stream based protocols there could be another message coming directly after this one so you just cant read until the ChannelBuffer runs out of bytes. Therefore, you must check how much you have read "manually" and based on that decide whether you are done with processing the payload of this message or not.

Returns:

payloadCompleted

public boolean payloadCompleted()

Check whether we have read the entire payload.

Returns:

getContentLength

public int getContentLength()

Get the content length of this message. A return value of -1 (negative 1) means that we do not know how big the payload of the message is. This also means that we still haven't located the Content-Length header within the message (if there is one).

Returns:

setContentLength

public void setContentLength(int contentLength)
                      throws MaxMessageSizeExceededException

Set the expected content length of this message. This value comes from the Content-Length header and if it is exceeding the maximum allowed payload length then we will throw a MaxMessageSizeExceededException.

Parameters:

contentLength - the content length of the payload

Throws:

MaxMessageSizeExceededException - in case the payload exceeds the maximum allowed length.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object