JAIN(tm) SIP API Release 0.6: Interface JainSipListener

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

jain.protocol.ip.sip
Interface JainSipListener

public interface JainSipListener
extends java.util.EventListener

This interface defines the methods required by all SIP user applications to receive and process JAIN SIP Events that are emitted by an object implementing the JainSipProvider interface. It must be noted that any object that implements the:

JainSipListener Interface is referred to as JainSipListenerImpl.
JainSipProvider Interface is referred to as JainSipProviderImpl.

The Events emitted by a JainSipProvider may be one of two types:

Version:: 0.6
See Also:: JainSipProvider

Method Summary

void processAck(AckMessage ack, int serverTransactionId)
          Processes an AckMessage received on one of the JainSipListener's ListeningPoints.

void processCancel(CancelMessage cancel, int serverTransactionId)
          Processes a CancelMessage received on one of the JainSipListener's ListeningPoints.

void processRequest(RequestMessage request, int serverTransactionId)
          Processes a RequestMessage received on one of the JainSipListener's ListeningPoints.

void processResponse(ResponseMessage response, int clientTransactionId)
          Processes a ResponseMessage received on one of the JainSipListener's ListeningPoints.

void processTimeOut(int transactionId, boolean isServerTransaction)
          Processes the time out of a transaction specified by the transactionId.

Method Detail

processRequest

public void processRequest(RequestMessage request,
                           int serverTransactionId)

Processes a RequestMessage received on one of the JainSipListener's ListeningPoints. Note that AckMessages and CancelMessages must not be passed to this method.

Parameters:: request - the RequestMessage received; serverTransactionId - the transaction ID of the server transaction associated with this RequestMessage

processResponse

public void processResponse(ResponseMessage response,
                            int clientTransactionId)

Processes a ResponseMessage received on one of the JainSipListener's ListeningPoints.

Parameters:: response - the ResponseMessage received; clientTransactionId - the transaction ID of the client transaction associated with this ResponseMessage

processTimeOut

public void processTimeOut(int transactionId,
                           boolean isServerTransaction)

Processes the time out of a transaction specified by the transactionId.

Parameters:: transactionId - the transaction ID of the transaction that timed out.; isServerTransaction - boolean value to indicate if transactionId corresponds to a server transaction

processAck

public void processAck(AckMessage ack,
                       int serverTransactionId)

Processes an AckMessage received on one of the JainSipListener's ListeningPoints.

Parameters:: ack - the AckMessage received; serverTransactionId - the transaction ID of the server transaction associated with this AckMessage

processCancel

public void processCancel(CancelMessage cancel,
                          int serverTransactionId)

Processes a CancelMessage received on one of the JainSipListener's ListeningPoints.

Parameters:: cancel - the CancelMessage received; serverTransactionId - the transaction ID of the server transaction associated with this CancelMessage