|
JAIN-SIP 2.0 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ListeningPoint
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.
Field Summary | |
---|---|
static int |
PORT_5060
Port Constant: Default port 5060. |
static int |
PORT_5061
Port Constant: Default port 5061. |
static String |
SCTP
Transport constant: SCTP |
static String |
TCP
Transport constant: TCP |
static String |
TLS
Transport constant: TLS over TCP |
static String |
UDP
Transport constant: UDP |
Method Summary | |
---|---|
ContactHeader |
createContactHeader()
Create a contact for this listening point. |
ViaHeader |
createViaHeader()
Create a Via header for this listening point. |
boolean |
equals(Object obj)
This method indicates whether the specified object is equal to this Listening Point. |
String |
getIPAddress()
Gets the IP of the ListeningPoint. |
int |
getPort()
Gets the port of the ListeningPoint. |
String |
getSentBy()
Gets the sentBy attribute of the ListeningPoint. |
String |
getTransport()
Gets the transport of the ListeningPoint. |
void |
sendHeartbeat(String ipAddress,
int port)
Send a heartbeat to the specified Ip address and port via this listening point. |
void |
setSentBy(String sentBy)
Sets the sentBy string for this ListeningPoint. |
Field Detail |
---|
static final String TCP
static final String UDP
static final String SCTP
static final String TLS
static final int PORT_5060
static final int PORT_5061
Method Detail |
---|
int getPort()
String getTransport()
String getIPAddress()
void setSentBy(String sentBy) throws ParseException
sentBy
- the sentBy string to be set in requests top most Via
headers.
ParseException
- which signals that an error has been reached
unexpectedly while parsing the sentBy value.String getSentBy()
ContactHeader createContactHeader()
void sendHeartbeat(String ipAddress, int port) throws IOException
IOException
ViaHeader createViaHeader()
boolean equals(Object obj)
equals
in class Object
obj
- the object with which to compare this ListeningPoint.
|
JAIN-SIP 2.0 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |