|
JSIP API v1.2 November 2006 |
||||||||
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES |
See:
Description
Interface Summary | |
---|---|
ClientTransaction | A client transaction is used by a User Agent Client application to send Request messages to a User Agent Server application. |
Dialog | A dialog represents a peer-to-peer SIP relationship between two user agents that persists for some time. |
ListeningPoint | This interface represents a unique IP network listening point, which consists of port transport and IP. |
ServerTransaction | A server transaction is used by a SipProvider to handle incoming Request messages to fire Request events to the SipListener on a specific server transaction and by a User Agent Server application to send Response messages to a User Agent Client application. |
SipListener | This interface represents the application view to a SIP stack therefore defines the application's communication channel to the SIP stack. |
SipProvider | This interface represents the messaging entity of a SIP stack and as such is the interface that defines the messaging and transactional component view of the SIP stack. |
SipStack | This interface represents the management interface of a SIP stack implementing this specification and as such is the interface that defines the management/architectural view of the SIP stack. |
Transaction | Transactions are a fundamental component of SIP. |
Class Summary | |
---|---|
DialogState | This class contains the enumerations that define the underlying state of an existing dialog. |
DialogTerminatedEvent | DialogTerminatedEvent is delivered to the Listener when the dialog transitions to the terminated state. |
IOExceptionEvent | This object is used to signal to the application that an IO Exception has occured. |
RequestEvent | This class represents an Request event that is passed from a SipProvider to its SipListener. |
ResponseEvent | This class represents a Response event that is passed from a SipProvider to its SipListener. |
SipFactory | The SipFactory is a singleton class which applications can use a single access point to obtain proprietary implementations of this specification. |
Timeout | This class contains the enumerations that define whether a timeout has occured in the underlying implementation. |
TimeoutEvent | This class represents an Timeout event that is passed from a SipProvider to its SipListener. |
TransactionState | This class contains the enumerations that define the underlying state of an existing transaction. |
TransactionTerminatedEvent | TransactionTerminatedEvent is delivered to the Listener when the transaction transitions to the terminated state. |
Exception Summary | |
---|---|
DialogDoesNotExistException | This Exception is thrown when a user attempts to reference Dialog that does currently not exist in the underlying SipProvider |
InvalidArgumentException | This exception class is thrown by an implementation when given an invalid argument such as a invalid numerical value. |
ObjectInUseException | This exception is thrown by a method that is unable to delete a specified Object because the Object is still in use by the underlying implementation. |
PeerUnavailableException | The PeerUnavailableException indicates that a vendor's implementation of a JAIN SIP interface could not be created for some reason. |
ProviderDoesNotExistException | This Exception is thrown when a user attempts to start the SipStack without any SipProviders created to service requests and responses. |
SipException | A SipException is thrown when a general SIP exception is encountered, when no other specialized exception defined in this specification can handle the error. |
TransactionAlreadyExistsException | This Exception is thrown when a user attempts to get a transaction to handle a message when infact a transaction is already handling this message. |
TransactionDoesNotExistException | This Exception is thrown when a user attempts to reference a client or server transaction that does currently not exist in the underlying SipProvider |
TransactionUnavailableException | The TransactionUnavailableException indicates that a vendor's implementation could not create a Transaction for some reason. |
TransportAlreadySupportedException | The TransportAlreadySupportedException indicates that a specific transport is already supported by a SipProvider via its ListeningPoints. |
TransportNotSupportedException | The TransportNotSupportedException indicates that a specific transport is not supported by a vendor's implementation of this specification. |
This package contains the main interfaces that model the architecture from both an application developer and a stack vendor view.
SipStack - This interface can be viewed as the stack management interface of the architecture. The SipStack interface encapsulates the dynamic management characteristics of the SIP stack, such as ListeningPoints which encapsulate port and transport. As well as the central point for the creation and querying of SipProviders in the architecture .
SipProvider - This interface can be viewed as the messaging
interface of the architecture. Multiple SipProviders are allowed
within the architecture. This interface defines the methods that allow
an application implementing the SipListener to register with the SipProvider
to recieve incoming requests and responses. The methods defined to
send SIP messages are also defined within the SipProvider
|
JSIP API v1.2 November 2006 |
||||||||
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES |