|
NIST SIP Parser and Stack (v1.2) API | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--gov.nist.javax.sip.stack.SIPStack | +--gov.nist.javax.sip.stack.SIPTransactionStack | +--gov.nist.javax.sip.SipStackImpl
Implementation of SipStack. The JAIN-SIP stack is initialized by a set of properties (see the JAIN SIP documentation for an explanation of these properties). In addition to these, the following are meaningful properties for the NIST SIP stack (specify these in the property array when you create the JAIN-SIP statck).:
Field Summary |
Fields inherited from class gov.nist.javax.sip.stack.SIPTransactionStack |
BASE_TIMER_INTERVAL |
Fields inherited from class gov.nist.javax.sip.stack.SIPStack |
DEFAULT_PORT |
Constructor Summary | |
SipStackImpl(Properties configurationProperties)
|
Method Summary | |
ListeningPoint |
createListeningPoint(int port,
String transport)
Creates a new peer ListeningPoint on this SipStack on a specified host, port and transport and returns a reference to the newly created ListeningPoint object. |
SipProvider |
createSipProvider(ListeningPoint listeningPoint)
Creates a new peer SipProvider on this SipStack on a specified ListeningPoint and returns a reference to the newly created SipProvider object. |
void |
deleteListeningPoint(ListeningPoint listeningPoint)
Deletes the specified peer ListeningPoint attached to this SipStack. |
void |
deleteSipProvider(SipProvider sipProvider)
Deletes the specified peer SipProvider attached to this SipStack. |
String |
getIPAddress()
Gets the IP Address that identifies this SipStack instance. |
ListeningPointImpl |
getListeningPoint(int port,
String transport)
Get the listening point for a given transport and port. |
Iterator |
getListeningPoints()
Returns an Iterator of existing ListeningPoints created by this SipStackImpl. |
String |
getOutboundProxy()
get the outbound proxy specification. |
boolean |
getRetransmissionFilter()
This method returns the value of the retransmission filter helper function for User Agent Client and User Agent Server applications. |
Router |
getRouter()
Gets the Router object that identifies the default Routing policy of this SipStack. |
Iterator |
getSipProviders()
Returns an Iterator of existing peer SipProviders that have been created by this SipStackImpl. |
String |
getStackName()
Gets the user friendly name that identifies this SipStack instance. |
void |
transactionErrorEvent(SIPTransactionErrorEvent transactionErrorEvent)
Invoked when an error has ocurred with a transaction. |
Methods inherited from class gov.nist.javax.sip.stack.SIPTransactionStack |
addExtensionMethod, addTransaction, createClientTransaction, createDialog, createMessageChannel, createMessageChannel, createMessageChannel, createRawMessageChannel, createServerTransaction, findCancelTransaction, findTransaction, getDialog, isDialogCreated, putDialog |
Methods inherited from class gov.nist.javax.sip.stack.SIPStack |
addMessageProcessor, createMessageProcessor, exportServerLog, getBadMessageLog, getDefaultRoute, getDefaultRouteHeader, getHostAddress, getMessageProcessor, getMessageProcessors, getNextHop, getNextHop, getPort, getRouteHeader, getStackFunction, isAlive, isTransportEnabled, isTransportEnabled, logBadMessage, removeMessageProcessor, setHostAddress, setMaxConnections, setRouter, setSingleThreaded, setStackMessageFactory, setStackName, setThreadPoolSize, stopStack |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public SipStackImpl(Properties configurationProperties) throws PeerUnavailableException
Method Detail |
public ListeningPoint createListeningPoint(int port, String transport) throws TransportNotSupportedException, InvalidArgumentException
SipStack.getListeningPoints()
of this
SipStack, once it has been successfully created.
createListeningPoint
in interface SipStack
port
- - the port of the new ListeningPoint.transport
- - the transport of the new ListeningPoint.
InvalidArgumentException
- if the specified port is invalid.
TransportNotSupportedException
public SipProvider createSipProvider(ListeningPoint listeningPoint) throws ObjectInUseException
SipStack.getSipProviders()
of this SipStack, once it has been
successfully created.
createSipProvider
in interface SipStack
listeningPoint
- - the ListeningPoint the SipProvider is to be
attached to in order to send and receive messages.
ListeningPointUnavailableException
- thrown if another
SipProvider is already using the ListeningPoint.
ObjectInUseException
- if another SipProvider is
already using the ListeningPoint.public void deleteListeningPoint(ListeningPoint listeningPoint) throws ObjectInUseException
SipStack.getListeningPoints()
of this SipStack.
deleteListeningPoint
in interface SipStack
listeningPoint
- - the SipProvider to be deleted from this SipStack.
ObjectInUseException
- thrown if the specified peer
ListeningPoint cannot be deleted because the peer ListeningPoint is
currently in use.
ObjectInUseException
- if the specified ListeningPoint cannot be
deleted because the ListeningPoint is currently in use.public void deleteSipProvider(SipProvider sipProvider) throws ObjectInUseException
SipStack.getSipProviders()
of this SipStack. Deletion of a
SipProvider does not automatically delete the ListeningPoint from the
SipStack.
deleteSipProvider
in interface SipStack
sipProvider
- - the peer SipProvider to be deleted from this
SipStack.
ObjectInUseException
- thrown if the specified peer
SipProvider cannot be deleted because the peer SipProvider is currently
in use.
ObjectInUseException
- if the specified SipProvider cannot be
deleted because the SipProvider is currently in use.public String getIPAddress()
SipFactory.createSipStack(Properties)
method upon
creation of the SIP Stack object.
getIPAddress
in interface SipStack
public Iterator getListeningPoints()
getListeningPoints
in interface SipStack
public ListeningPointImpl getListeningPoint(int port, String transport)
public String getOutboundProxy()
public boolean getRetransmissionFilter()
SipFactory.createSipStack(Properties)
method upon creation of the SIP Stack
object.
The default value of the retransmission filter boolean is false.
When retransmissions are handled by the SipProvider the application will
not receive Timeout.RETRANSMIT
notifications encapsulated in
TimeoutEvent
's. However an application will get
notified when a the underlying transaction expired with
Timeout.TRANSACTION
notifications encapsulated in a
TimeoutEvent
.
getRetransmissionFilter
in interface SipStack
public Router getRouter()
SipFactory.createSipStack(Properties)
method upon
creation of the SIP Stack object.
getRouter
in interface SipStack
getRouter
in class SIPStack
public Iterator getSipProviders()
getSipProviders
in interface SipStack
public String getStackName()
SipFactory.createSipStack(Properties)
method upon creation of the SIP Stack
object.
getStackName
in interface SipStack
getStackName
in class SIPStack
public void transactionErrorEvent(SIPTransactionErrorEvent transactionErrorEvent)
transactionErrorEvent
in interface SIPTransactionEventListener
transactionErrorEvent
- Error event.
|
NIST SIP Parser and Stack (v1.2) API | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |