javax.servlet.sip

Interface Flow

public interface Flow

As per RFC 5626, flow is a transport-layer association between two hosts that is represented by the network address and port number of both ends and by the transport protocol. For TCP, a flow is equivalent to a TCP connection. For UDP a flow is a bidirectional stream of datagrams between a single pair of IP addresses and ports of both peers. From a SIP servlet application’s perspective, flow is a transport layer association between SIP servlet container and another SIP endpoint on a specific transport.

Since:

2.0

Method Summary

Methods

Modifier and Type	Method and Description
SipURI	getLocalURI() Represents the local endpoint of the transport association represented by this flow.
SipURI	getRemoteURI() Represents the remote endpoint of the transport association represented by this flow.
String	getToken() Gets the flow token representing this flow as defined by RFC 5626.
boolean	isActive() Returns whether the flow is active or not.
void	release() Indicate to the container that the application invoking this method is not interested in using this Flow any more.

Method Detail

getToken

String getToken()

Gets the flow token representing this flow as defined by RFC 5626.

Returns:

String representing the flow token of this flow.

getLocalURI

SipURI getLocalURI()

Represents the local endpoint of the transport association represented by this flow.

Returns:

SipURI instance representing local endpoint.

getRemoteURI

SipURI getRemoteURI()

Represents the remote endpoint of the transport association represented by this flow.

Returns:

SipURI instance representing remote endpoint.

release

void release()

Indicate to the container that the application invoking this method is not interested in using this Flow any more. This act as a hint to the container vendors in stopping the keep-alive and/or terminating the underlying transport association of the flow.

isActive

boolean isActive()

Returns whether the flow is active or not.

Returns:

True if the flow is active, false if the flow is already closed.