org.cafesip.sipunit
Interface MessageListener

All Superinterfaces:
RequestListener
All Known Implementing Classes:
PresenceNotifySender, SipCall, Subscription

public interface MessageListener
extends RequestListener

MessageListener represents certain SipUnit objects (such as SipCall and Subscription) that perform SIP messaging on behalf of a user program. This interface provides a uniform way of retrieving messages received by such SipUnit objects. Internally, this interface is used for asynchronous reception of SIP requests, responses, and response timeouts.


Method Summary
 java.util.ArrayList<SipRequest> getAllReceivedRequests()
          This method returns all the requests received by this object and can be called directly by a test program.
 java.util.ArrayList<SipResponse> getAllReceivedResponses()
          This method returns all the responses received by this object and can be called directly by a test program.
 SipRequest getLastReceivedRequest()
          This method returns the last request received by this object and can be called directly by a test program.
 SipResponse getLastReceivedResponse()
          This method returns the last response received by this object and can be called directly by a test program.
 
Methods inherited from interface org.cafesip.sipunit.RequestListener
processEvent
 

Method Detail

getAllReceivedResponses

java.util.ArrayList<SipResponse> getAllReceivedResponses()
This method returns all the responses received by this object and can be called directly by a test program.

Returns:
ArrayList of zero or more SipResponse objects.

getAllReceivedRequests

java.util.ArrayList<SipRequest> getAllReceivedRequests()
This method returns all the requests received by this object and can be called directly by a test program.

Returns:
ArrayList of zero or more SipRequest objects.

getLastReceivedRequest

SipRequest getLastReceivedRequest()
This method returns the last request received by this object and can be called directly by a test program.

Returns:
A SipRequest object representing the last request message received, or null if none has been received.

getLastReceivedResponse

SipResponse getLastReceivedResponse()
This method returns the last response received by this object and can be called directly by a test program.

Returns:
A SipResponse object representing the last response message received, or null if none has been received.


http://www.cafesip.org