org.mobicents.mscontrol
Interface MsLink

All Superinterfaces:

java.io.Serializable

public interface MsLink
extends java.io.Serializable

A MsLink represents link between two org.mobicents.media.server.spi.Endpoint Application creates instance of MsLink by calling MsSession.createLink(MsLinkMode) As soon MsLink is created MsSession call's MsLink.fireMsLinkCreated() to fire the Event MsLinkEventID.LINK_CREATED MsLink maintains the reference to MsSession object for life of MsLink

Author:

Oleg Kulikov, amit.bhayani

Method Summary

void	fireMsLinkCreated() As soon as MsLink is created MsSession call's MsLink.fireMsLinkCreated() to fire the Event MsLinkEventID.LINK_CREATED
java.lang.String[]	getEndpoints() Returns back the Endpoints names that this link is trying to join
java.lang.String	getId() Gets the Link ID
MsSession	getSession() Gets the session to which this links belongs
org.mobicents.media.msc.common.MsLinkState	getState() Returns the state of MsLink
void	join(java.lang.String a, java.lang.String b) Joins specified endpoints.
void	release() Drops this link

Method Detail

getId

java.lang.String getId()

Gets the Link ID

Returns:

getState

org.mobicents.media.msc.common.MsLinkState getState()

Returns the state of MsLink

Returns:

getSession

MsSession getSession()

Gets the session to which this links belongs

Returns:

the session object.

join

void join(java.lang.String a,
          java.lang.String b)

Joins specified endpoints.

Parameters:

a - the name of the first endpoint.

b - the name of the second endpoint.

getEndpoints

java.lang.String[] getEndpoints()

Returns back the Endpoints names that this link is trying to join

Returns:

release

void release()

Drops this link

fireMsLinkCreated

void fireMsLinkCreated()

As soon as MsLink is created MsSession call's MsLink.fireMsLinkCreated() to fire the Event MsLinkEventID.LINK_CREATED