|
| |
|
| java.lang.Object
 gov.nist.siplite.stack.SIPMessageStack
gov.nist.siplite.stack.SIPTransactionStack
gov.nist.siplite.SipStack
| SipStack | | public class SipStack extends SIPTransactionStack (Code) | | 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).:
- gov.nist.javax.sip.TRACE_LEVEL = integer
Currently only 16 and 32 is meaningful.
If this is set to 16 or above, then incoming
valid messages are logged in SERVER_LOG. If you set this to 32 and
specify a DEBUG_LOG then vast amounts of trace information will be dumped
in to the specified DEBUG_LOG. The server log accumulates the signaling
trace.
This can be viewed using the trace viewer tool .
Please send us both the server log and debug log
when reporting non-obvious problems.
version:
JAIN-SIP-1.1
version:
This code is in the public domain. |
| outboundPort | | protected int outboundPort(Code) | | Outbound proxy port for this stack
|
| outboundProxy | | protected String outboundProxy(Code) | | Outbound proxy for this stack
|
| stackInitialized | | protected boolean stackInitialized(Code) | | Flag indicating the provider has been initialized.
|
| SipStack | | protected SipStack()(Code) | | Creates a new instance of SipStack.
|
| createListeningPoint | | public synchronized ListeningPoint createListeningPoint(int port, String transport) throws TransportNotSupportedException, IllegalArgumentException(Code) | | 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. The newly created ListeningPoint is implicitly
attached to this SipStack upon execution of this method, by adding the
ListeningPoint to the
SipStack.getListeningPoints of this
SipStack, once it has been successfully created.
Parameters:
port - the port of the new ListeningPoint.
Parameters:
transport - the transport of the new ListeningPoint.SipStack. The peer ListeningPoint attached to this SipStack. |
| createSipProvider | | public SipProvider createSipProvider(ListeningPoint listeningPoint) throws ObjectInUseException(Code) | | Creates a new peer SipProvider on this SipStack on a specified
ListeningPoint and returns a reference to the newly created SipProvider
object. The newly created SipProvider is implicitly attached to this
SipStack upon execution of this method, by adding the SipProvider to the
SipStack.getSipProviders of this SipStack, once it has been
successfully created.
Parameters:
listeningPoint - the ListeningPoint the SipProvider is tobe attached to in order to send and Receive messages. The peer SipProvider attached to this SipStack on the specifiedListeningPoint.
throws:
ListeningPointUnavailableException - thrown if anotherSipProvider is already using the ListeningPoint. |
| deleteListeningPoint | | public void deleteListeningPoint(ListeningPoint listeningPoint) throws ObjectInUseException(Code) | | Deletes the specified peer ListeningPoint attached to this SipStack. The
specified ListeningPoint is implicitly detached from this SipStack upon
execution of this method, by removing the ListeningPoint from the
SipStack.getListeningPoints of this SipStack.
Parameters:
listeningPoint - the peer SipProvider to be deleted fromthis SipStack.
exception:
ObjectInUseException - thrown if the specified peerListeningPoint cannot be deleted because the peer ListeningPoint iscurrently in use.
since:
v1.1 |
| deleteSipProvider | | public void deleteSipProvider(SipProvider sipProvider) throws ObjectInUseException(Code) | | Deletes the specified peer SipProvider attached to this SipStack. The
specified SipProvider is implicitly detached from this SipStack upon
execution of this method, by removing the SipProvider from the
SipStack.getSipProviders of this SipStack. Deletion of a
SipProvider does not automatically delete the ListeningPoint from the
SipStack.
Parameters:
sipProvider - the peer SipProvider to be deleted fromthis SipStack.
exception:
ObjectInUseException - thrown if the specified peerSipProvider cannot be deleted because the peer SipProvider is currentlyin use. |
| getDefaultTransport | | public String getDefaultTransport()(Code) | | The default transport to use for via headers.
the default transport |
| getIPAddress | | public String getIPAddress()(Code) | | Gets the IP Address that identifies this SipStack instance. Every Sip
Stack object must have an IP Address and only a single SipStack object
can service a single IP Address. This value is set using the Properties
object passed to the
SipFactory.createSipStack method upon
creation of the SIP Stack object.
a string identifing the IP Address
since:
v1.1 |
| getListeningPoint | | public ListeningPoint getListeningPoint(int port, String transport)(Code) | | Gets the listening point for a given transport and port.
Parameters:
port - the communication port
Parameters:
transport - the connection channel the listening port |
| getListeningPoints | | public java.util.Enumeration getListeningPoints()(Code) | | Returns an Iterator of existing ListeningPoints created by this
SipStack. All of the peer SipProviders of this SipStack will be
proprietary objects belonging to the same stack vendor.
an Iterator containing all existing peer ListeningPoints createdby this SipStack. Returns an empty Iterator if no ListeningPoints exist. |
| getOutboundProxy | | public String getOutboundProxy()(Code) | | Gets the outbound proxy specification. Return null if no outbound
proxy is specified.
the outbound proxy address |
| getRouter | | public Router getRouter()(Code) | | Gets the Router object that identifies the default
Routing policy of this
SipStack. It also provides means to set an outbound proxy. This value is
set using the Properties object passed to the
SipFactory.createSipStack method upon
creation of the SIP Stack object.
a the Router object identifying the Router policy.
since:
v1.1 |
| getSipListener | | public SipListener getSipListener()(Code) | | Gets the sip listener for the stack.
the SIP listener |
| getSipProviders | | public Enumeration getSipProviders()(Code) | | Returns an Iterator of existing peer SipProviders that have been
created by this SipStack. All of the peer SipProviders of this
SipStack will be proprietary objects belonging to the same stack vendor.
an Iterator containing all existing peer SipProviders createdby this SipStack. Returns an empty Iterator if no SipProviders exist. |
| getStackName | | public String getStackName()(Code) | | Gets the user friendly name that identifies this SipStack instance. This
value is set using the Properties object passed to the
SipFactory.createSipStack method upon
creation of the SIP Stack object.
a string identifing the stack instance |
| isRetransmissionFilterActive | | public boolean isRetransmissionFilterActive()(Code) | | This method returns the value of the retransmission filter helper
function for User Agent Client and User Agent Server applications. This
value is set using the Properties object passed to the
SipFactory.createSipStack 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
gov.nist.siplite.TimeoutEvent 's. However an application will get
notified when a the underlying transaction expired with
Timeout.TRANSACTION notifications encapsulated in a
gov.nist.siplite.TimeoutEvent .
the value of the retransmission filter, true if the filteris set false otherwise.
since:
v1.1 |
| setStackConnector | | public void setStackConnector(StackConnector stackConnector)(Code) | | Constructor.
Parameters:
stackConnector - connection to use for SIP Stack |
| stopStack | | public void stopStack()(Code) | | Stops the SIP stack processing.
|
| transactionErrorEvent | | public void transactionErrorEvent(SIPTransactionErrorEvent transactionErrorEvent)(Code) | | Invoked when an error has ocurred with a transaction.
Parameters:
transactionErrorEvent - Error event. |
|
|
|