org.mobicents.media.control.mgcp.connection

Class MgcpLocalConnection

java.lang.Object

org.mobicents.media.control.mgcp.connection.AbstractMgcpConnection

org.mobicents.media.control.mgcp.connection.MgcpLocalConnection

All Implemented Interfaces:

MgcpConnection

public class MgcpLocalConnection
extends AbstractMgcpConnection

Type of connection that connects two endpoints locally.

Author:

Henrique Rosa (henrique.rosa@telestax.com)

Field Summary

Fields inherited from class org.mobicents.media.control.mgcp.connection.AbstractMgcpConnection

state, stateLock

Constructor Summary

Constructors

Constructor and Description
MgcpLocalConnection(int identifier, ChannelsManager channelProvider)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the connection.
AudioComponent	getAudioComponent() Gets the in-band audio component of the connection.
OOBComponent	getOutOfBandComponent() Gets the out-of-band audio component of the connection.
String	halfOpen(LocalConnectionOptions options) The connection allocates resources and becomes half-open, sending an SDP offer to the remote peer.
boolean	isLocal() Gets whether the connection is local or remote.
void	join(MgcpLocalConnection otherConnection)
String	open(String sdp) Moves the connection to an open state.
void	setMode(ConnectionMode mode) Sets the mode of the connection.

Methods inherited from class org.mobicents.media.control.mgcp.connection.AbstractMgcpConnection

getHexIdentifier, getIdentifier, getMode, getState

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MgcpLocalConnection

public MgcpLocalConnection(int identifier,
                   ChannelsManager channelProvider)

Method Detail

isLocal

public boolean isLocal()

Description copied from interface: MgcpConnection

Gets whether the connection is local or remote.

Returns:

true if connection is local; false if it is remote.

halfOpen

public String halfOpen(LocalConnectionOptions options)
                throws MgcpConnectionException

Description copied from interface: MgcpConnection

The connection allocates resources and becomes half-open, sending an SDP offer to the remote peer.

The connection must then wait for the remote peer to reply with MDCX request containing an SDP answer or for a DLCX request that terminates the connection. description.

Parameters:

options - The options that configure the connection.

Returns:

The SDP offer.

Throws:

MgcpConnectionException - If connection state is not closed.

open

public String open(String sdp)
            throws MgcpConnectionException

Description copied from interface: MgcpConnection

Moves the connection to an open state.

If the call is inbound, then the remote peer will provide an SDP offer and the connection will allocate resources and provide and SDP answer right away.

If the call is outbound, the connection MUST move from an half-open state. In this case, the remote peer provides the MGCP answer and the connection can be established between both peers.

Parameters:

sdp - The SDP description of the remote peer.

Returns:

The SDP answer if the call is inbound; null if call is outbound.

Throws:

MgcpConnectionException - If connection state is not closed nor half-open.

join

public void join(MgcpLocalConnection otherConnection)
          throws MgcpConnectionException

Throws:

MgcpConnectionException

close

public void close()
           throws MgcpConnectionException

Description copied from interface: MgcpConnection

Closes the connection.

Throws:

MgcpConnectionException - If connection state is not half-open nor open.

setMode

public void setMode(ConnectionMode mode)
             throws IllegalStateException

Description copied from interface: MgcpConnection

Sets the mode of the connection.

Specified by:

setMode in interface MgcpConnection

Overrides:

setMode in class AbstractMgcpConnection

Parameters:

mode - The new mode of the connection

Throws:

IllegalStateException - Cannot update mode of closed connections

getAudioComponent

public AudioComponent getAudioComponent()

Description copied from interface: MgcpConnection

Gets the in-band audio component of the connection.

Specified by:

getAudioComponent in interface MgcpConnection

Specified by:

getAudioComponent in class AbstractMgcpConnection

Returns:

The in-band media component

getOutOfBandComponent

public OOBComponent getOutOfBandComponent()

Description copied from interface: MgcpConnection

Gets the out-of-band audio component of the connection.

Specified by:

getOutOfBandComponent in interface MgcpConnection

Specified by:

getOutOfBandComponent in class AbstractMgcpConnection

Returns:

The out-of-band media component