|
Interface Summary |
| MsConnection |
Represents the actual RTP connection. |
| MsConnectionEvent |
The instance of MsConnectionEvent is fired when ever the state
of MsConnection changes |
| MsConnectionListener |
The class interested in receiving the MsConnectionEvent should
implement this interface. |
| MsEndpoint |
Media Server contain endpoints on which the Call-Agent/Application can
create, modify and delete connections in order to establish and control media
sessions with other multimedia endpoints. |
| MsLink |
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 |
| MsLinkEvent |
Instance of MsLinkEvent is fired when ever state of MsLink is changed |
| MsLinkListener |
The class interested in receiving the MsLinkEvent should implement
this interface. |
| MsNotificationListener |
Applications that have registered for notification from Endpoint for
particular event like DTMF should implement MsNotificationListener |
| MsNotifyEvent |
MsNotify uses system wide defined constants for eventID and eventCause -
reason for that to happen is that MsNotifyEvent conveys information passed
throw signaling from and to Media Server |
| MsPeer |
Used to get the instance of MsProvider class |
| MsProvider |
This is the provider class which is used to create the MsSession. |
| MsResource |
Deprecated. |
| MsResourceListener |
Deprecated. |
| MsSession |
A MsSession is a transient association of (zero or more)
connection for the purposes of engaging in a real-time communications
interchange. |
| MsSessionEvent |
This is the interface for all MsSession-related events. |
| MsSessionListener |
The class interested in receiving the MsSessionEvent should implement
this interface. |
| MsSignalDetector |
Deprecated. |
| MsSignalGenerator |
Deprecated. |
|
Enum Summary |
| MsConnectionEventCause |
When the state of MsConnection is changed MsConnectionEvent is fired which
has MsConnectionEventCause representing the cause of event
NORMAL Represents the MsConnectionEvent is fired because
the operation is successful. |
| MsConnectionEventID |
Whenever the state of MsConnection changes MsConnectionEvent is fired and
change in state is represented by MsConnectionEventID *
CONNECTION_CREATED Fired as soon as creation of
MsConnection is successful. |
| MsConnectionState |
MsConnectionState represents the state of MsConnection. |
| MsLinkEventCause |
When the state of Mslink is changed MsLinkEvent is fired which has
MsLinkEventCause representing the cause of event
NORMAL Represents the MsLinkEvent is fired because the
operation is successful. |
| MsLinkEventID |
Whenever the state of MsLink changes MsLinkEvent is
fired and change in state is represented by MsLinkEventID
LINK_CREATED As soon as new MsLink is created
LINK_CREATED is fired
LINK_JOINED Fired as soon as join operation of MsLink is
successful
LINK_DROPPED Fired as soon as release operation of MsLink
is successful
LINK_FAILED Fired as soon as join operation of MsLink
fails
|
| MsLinkMode |
MsLink are either one way represented as HALF_DUPLEX
or two way represented as FULL_DUPLEX |
| MsLinkState |
MsLinkState represents the state of MsLink. |
| MsSessionEventCause |
This enum is for MsSession events firing when
STATE of MsSession changes
SESSION_CREATED indicates the STATE of MsSession is IDLE
and new instance of MsSession is created
CONNECTION_CREATED indicates the STATE of MsSession is
changed to ACTIVE because createNetworkConnection called
CONNECTION_DROPPED indicates the STATE of MsSession is
changed (state may change to INVALID if this was the only resource viz.,
Connection or Link hold by this session) because drop called
LINK_CREATED indicates the STATE of MsSession is changed
to ACTIVE because createLink called
LINK_DROPPED indicates the STATE of MsSession is changed
(state may change to INVALID if this was the only resource viz., Link or
Connection hold by this session) because dropLink called
|
| MsSessionEventID |
SESSION_CREATED indicates that the MsSession object has been created and is in the MsSessionState.IDLE state.
SESSION_ACTIVE indicates that the state of the MsSession object has changed to MsSessionState.ACTIVE
SESSION_INVALID indicates that the state of the MsSession object has changed to MsSessionState.INVALID
|
| MsSessionState |
IDLE state indicates the Session has zero connections or
links.
ACTIVE state indicates the Session has one or more
connections or links.
INVALID state indicates the Session has lost all of its
connections or links.
|