gov.nist.javax.sip.stack

Class UDPMessageProcessor

java.lang.Object

gov.nist.javax.sip.stack.MessageProcessor

gov.nist.javax.sip.stack.UDPMessageProcessor

All Implemented Interfaces:

Runnable

public class UDPMessageProcessor
extends MessageProcessor
implements Runnable

Sit in a loop and handle incoming udp datagram messages. For each Datagram packet, a new UDPMessageChannel is created (upto the max thread pool size). Each UDP message is processed in its own thread).

Version:

1.2 $Revision: 1.46 $ $Date: 2010-12-02 22:04:12 $

Author:

M. Ranganathan
See the implementation sequence diagram for processing incoming requests. Acknowledgement: Jeff Keyser contributed ideas on starting and stoppping the stack that were incorporated into this code. Niklas Uhrberg suggested that thread pooling be added to limit the number of threads and improve performance.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	isRunning A flag that is set to false to exit the message processor (suggestion by Jeff Keyser).
protected LinkedList	messageChannels A list of message channels that we have started.
protected BlockingQueue<DatagramQueuedMessageDispatch>	messageQueue Incoming messages are queued here.
protected DatagramSocket	sock
protected int	threadPoolSize Max # of udp message channels

Fields inherited from class gov.nist.javax.sip.stack.MessageProcessor

IN_ADDR_ANY, IN6_ADDR_ANY, sipStack, transport

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UDPMessageProcessor(InetAddress ipAddress, SIPTransactionStack sipStack, int port) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
MessageChannel	createMessageChannel(HostPort targetHostPort) Create and return new TCPMessageChannel for the given host/port.
MessageChannel	createMessageChannel(InetAddress host, int port) Create a message channel for the specified host/port.
int	getDefaultTargetPort() Default target port for UDP
int	getMaximumMessageSize() UDP can handle a message as large as the MAX_DATAGRAM_SIZE.
int	getPort() Get port on which to listen for incoming stuff.
SIPTransactionStack	getSIPStack() Returns the stack.
String	getTransport() Return the transport string.
boolean	inUse() Return true if there are any messages in use.
boolean	isSecure() UDP is not a secure protocol.
void	run() Thread main routine.
void	start() Start our processor thread.
void	stop() Shut down the message processor.

Methods inherited from class gov.nist.javax.sip.stack.MessageProcessor

getDefaultPort, getIpAddress, getListeningPoint, getSavedIpAddress, getSentBy, getViaHeader, initialize, isSentBySet, setIpAddress, setListeningPoint, setSentBy

Methods inherited from class java.lang.Object

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

Field Detail

messageQueue

protected BlockingQueue<DatagramQueuedMessageDispatch> messageQueue

Incoming messages are queued here.

messageChannels

protected LinkedList messageChannels

A list of message channels that we have started.

threadPoolSize

protected int threadPoolSize

Max # of udp message channels

sock

protected DatagramSocket sock

isRunning

protected boolean isRunning

A flag that is set to false to exit the message processor (suggestion by Jeff Keyser).

Constructor Detail

UDPMessageProcessor

protected UDPMessageProcessor(InetAddress ipAddress,
                   SIPTransactionStack sipStack,
                   int port)
                       throws IOException

Constructor.

Parameters:

sipStack - pointer to the stack.

Throws:

IOException

Method Detail

getPort

public int getPort()

Get port on which to listen for incoming stuff.

Overrides:

getPort in class MessageProcessor

Returns:

port on which I am listening.

start

public void start()
           throws IOException

Start our processor thread.

Specified by:

start in class MessageProcessor

Throws:

IOException

run

public void run()

Thread main routine.

Specified by:

run in interface Runnable

stop

public void stop()

Shut down the message processor. Close the socket for recieving incoming messages.

Specified by:

stop in class MessageProcessor

getTransport

public String getTransport()

Return the transport string.

Overrides:

getTransport in class MessageProcessor

Returns:

the transport string

getSIPStack

public SIPTransactionStack getSIPStack()

Returns the stack.

Specified by:

getSIPStack in class MessageProcessor

Returns:

my sip stack.

createMessageChannel

public MessageChannel createMessageChannel(HostPort targetHostPort)
                                    throws UnknownHostException

Create and return new TCPMessageChannel for the given host/port.

Specified by:

createMessageChannel in class MessageProcessor

Returns:

New MessageChannel for this processor.

Throws:

UnknownHostException

createMessageChannel

public MessageChannel createMessageChannel(InetAddress host,
                                  int port)
                                    throws IOException

Description copied from class: MessageProcessor

Create a message channel for the specified host/port.

Specified by:

createMessageChannel in class MessageProcessor

Returns:

New MessageChannel for this processor.

Throws:

IOException

getDefaultTargetPort

public int getDefaultTargetPort()

Default target port for UDP

Specified by:

getDefaultTargetPort in class MessageProcessor

isSecure

public boolean isSecure()

UDP is not a secure protocol.

Specified by:

isSecure in class MessageProcessor

getMaximumMessageSize

public int getMaximumMessageSize()

UDP can handle a message as large as the MAX_DATAGRAM_SIZE.

Specified by:

getMaximumMessageSize in class MessageProcessor

inUse

public boolean inUse()

Return true if there are any messages in use.

Specified by:

inUse in class MessageProcessor