| javax.sip.ListeningPoint
| ListeningPoint | | public interface ListeningPoint extends Cloneable,Serializable(Code) | | This interface represents a unique IP network listening point,
which consists of port transport and IP. A ListeningPoint is a Java
representation of the socket that a SipProvider messaging entity uses to send
and receive messages.
The ListeningPoint also includes an optional sent-by string parameter.
If set, this string will be placed in the sent-by parameter of the
top most Via header of outgoing requests.
author:
BEA Systems, NIST
version:
1.2 |
| Method Summary | |
| public boolean | equals(Object obj)
This method indicates whether the specified object is equal to this
Listening Point. | | public String | getIPAddress()
Gets the IP of the ListeningPoint. | | public int | getPort()
Gets the port of the ListeningPoint. | | public String | getSentBy()
Gets the sentBy attribute of the ListeningPoint. | | public String | getTransport()
Gets the transport of the ListeningPoint. | | public void | setSentBy(String sentBy)
Sets the sentBy string for this ListeningPoint. |
| PORT_5060 | | final public static int PORT_5060(Code) | | Port Constant: Default port 5060. This constant should only be used
when the transport of the ListeningPoint is set to UDP, TCP or SCTP.
|
| PORT_5061 | | final public static int PORT_5061(Code) | | Port Constant: Default port 5061. This constant should only be used
when the transport of the Listening Point is set to TLS over TCP or TCP
assuming the scheme is "sips".
|
| SCTP | | final public static String SCTP(Code) | | Transport constant: SCTP
|
| TCP | | final public static String TCP(Code) | | Transport constant: TCP
|
| TLS | | final public static String TLS(Code) | | Transport constant: TLS over TCP
|
| UDP | | final public static String UDP(Code) | | Transport constant: UDP
|
| equals | | public boolean equals(Object obj)(Code) | | This method indicates whether the specified object is equal to this
Listening Point. The specified object is equal to this ListeningPoint
if the specified object is a ListeningPoint and the transport and port
in the specified Listening Point is the same as this Listening Point.
Parameters:
obj - the object with which to compare this ListeningPoint. true if this ListeningPoint is "equal to" the obj argument;false otherwise. |
| getIPAddress | | public String getIPAddress()(Code) | | Gets the IP of the ListeningPoint.
since:
v1.2 the string value of the IP address. |
| getPort | | public int getPort()(Code) | | Gets the port of the ListeningPoint. The default port of a ListeningPoint
is dependent on the scheme and transport. For example:
- The default port is 5060, if the transport UDP and the scheme is
sip:.
- The default port is 5060, if the transport is TCP and the scheme
is sip:.
- The default port is 5060, if the transport is SCTP and the scheme
is sip:.
- The default port is 5061, if the transport is TLS over TCP and the
scheme is sip:.
- The default port is 5061, if the transport is TCP and the scheme
is sips:.
the integer value of the port. |
| getSentBy | | public String getSentBy()(Code) | | Gets the sentBy attribute of the ListeningPoint.
the string value of the sentBy attribute.
since:
v1.2 |
| getTransport | | public String getTransport()(Code) | | Gets the transport of the ListeningPoint.
the string value of the transport. |
| setSentBy | | public void setSentBy(String sentBy) throws ParseException(Code) | | Sets the sentBy string for this ListeningPoint. The sentBy String is
placed in the top most Via header of outgoing requests. This parameter
is optional and if it is not set, the top most Via header will use the
IP address and port assigned to the listening point for the sentBy field.
Parameters:
sentBy - the sentBy string to be set in requests top most Via headers.
throws:
ParseException - which signals that an error has been reachedunexpectedly while parsing the sentBy value.
since:
v1.2 |
|
|