net.java.sip.communicator.impl.protocol.sip
Interface SipMessageProcessor

All Known Implementing Classes:

OperationSetTypingNotificationsSipImpl

public interface SipMessageProcessor

Listener receiving events for incoming messages that need processing.

Author:

Damian Minkov

Method Summary

boolean	processMessage(javax.sip.RequestEvent requestEvent) Process the incoming message
boolean	processResponse(javax.sip.ResponseEvent responseEvent, Map<String,Message> sentMessages) Process the responses of sent messages
boolean	processTimeout(javax.sip.TimeoutEvent timeoutEvent, Map<String,Message> sentMessages) Processes a retransmit or expiration Timeout of an underlying Transactionhandled by this SipListener.

Method Detail

processMessage

boolean processMessage(javax.sip.RequestEvent requestEvent)

Process the incoming message

Parameters:

requestEvent - the incoming event holding the message

Returns:

whether this message needs further processing(true) or no(false)

processResponse

boolean processResponse(javax.sip.ResponseEvent responseEvent,
                        Map<String,Message> sentMessages)

Process the responses of sent messages

Parameters:

responseEvent - the incoming event holding the response

sentMessages - map containing sent messages

Returns:

whether this message needs further processing(true) or no(false)

processTimeout

boolean processTimeout(javax.sip.TimeoutEvent timeoutEvent,
                       Map<String,Message> sentMessages)

Processes a retransmit or expiration Timeout of an underlying Transactionhandled by this SipListener. This Event notifies the application that a retransmission or transaction Timer expired in the SipProvider's transaction state machine. The TimeoutEvent encapsulates the specific timeout type and the transaction identifier either client or server upon which the timeout occurred. The type of Timeout can by determined by: timeoutType = timeoutEvent.getTimeout().getValue();

Parameters:

sentMessages - map containing sent messages

timeoutEvent - the timeoutEvent received indicating either the message retransmit or transaction timed out.

Returns:

whether this message needs further processing(true) or no(false)