org.mobicents.media.control.mgcp.connection

Class AbstractMgcpConnection

java.lang.Object

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

All Implemented Interfaces:

MgcpConnection, MgcpEventSubject

Direct Known Subclasses:

MgcpLocalConnection, MgcpRemoteConnection

public abstract class AbstractMgcpConnection
extends Object
implements MgcpConnection

Base implementation for any MGCP connection.

Author:

Henrique Rosa (henrique.rosa@telestax.com)

Field Summary

Fields

Modifier and Type	Field and Description
protected com.google.common.util.concurrent.ListeningScheduledExecutorService	executor
protected static int	HALF_OPEN_TIMER
protected int	halfOpenTimeout
protected Set<MgcpEventObserver>	observers
protected MgcpConnectionState	state
protected Object	stateLock
protected int	timeout
protected com.google.common.util.concurrent.ListenableFuture<Integer>	timerFuture

Constructor Summary

Constructors

Constructor and Description
AbstractMgcpConnection(int identifier, int callId, int halfOpenTimeout, int openTimeout, MgcpEventProvider eventProvider, com.google.common.util.concurrent.ListeningScheduledExecutorService executor)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	expireIn(int timeout)
void	forget(MgcpEventObserver observer)
abstract AudioComponent	getAudioComponent() Gets the in-band audio component of the connection.
int	getCallIdentifier() Gets the call identifier.
String	getCallIdentifierHex() Gets the call identifier.
String	getHexIdentifier() Gets the connection identifier.
int	getIdentifier() Gets the connection identifier.
ConnectionMode	getMode() Gets the current mode of the connection.
abstract OOBComponent	getOutOfBandComponent() Gets the out-of-band audio component of the connection.
MgcpConnectionState	getState() Gets the current state of the connection
protected abstract boolean	isEventSupported(MgcpRequestedEvent event)
protected abstract void	listen(MgcpEvent event)
void	listen(MgcpRequestedEvent event) Requests the connection to send notifications about a certain event.
protected abstract org.apache.log4j.Logger	log()
void	notify(Object originator, MgcpEvent event)
void	observe(MgcpEventObserver observer)
void	setMode(ConnectionMode mode) Sets the mode of the connection.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mobicents.media.control.mgcp.connection.MgcpConnection

close, halfOpen, isLocal, open

Field Detail

state

protected volatile MgcpConnectionState state

stateLock

protected final Object stateLock

observers

protected final Set<MgcpEventObserver> observers

executor

protected final com.google.common.util.concurrent.ListeningScheduledExecutorService executor

HALF_OPEN_TIMER

protected static final int HALF_OPEN_TIMER

See Also:

Constant Field Values

timerFuture

protected com.google.common.util.concurrent.ListenableFuture<Integer> timerFuture

timeout

protected final int timeout

halfOpenTimeout

protected final int halfOpenTimeout

Constructor Detail

AbstractMgcpConnection

public AbstractMgcpConnection(int identifier,
                      int callId,
                      int halfOpenTimeout,
                      int openTimeout,
                      MgcpEventProvider eventProvider,
                      com.google.common.util.concurrent.ListeningScheduledExecutorService executor)

Method Detail

getIdentifier

public int getIdentifier()

Description copied from interface: MgcpConnection

Gets the connection identifier.

Specified by:

getIdentifier in interface MgcpConnection

Returns:

The connection identifier, in base 10

getHexIdentifier

public String getHexIdentifier()

Description copied from interface: MgcpConnection

Gets the connection identifier.

Specified by:

getHexIdentifier in interface MgcpConnection

Returns:

The connection identifier, in base 16.

getCallIdentifier

public int getCallIdentifier()

Description copied from interface: MgcpConnection

Gets the call identifier.

Specified by:

getCallIdentifier in interface MgcpConnection

Returns:

The call identifier, in base 10

getCallIdentifierHex

public String getCallIdentifierHex()

Description copied from interface: MgcpConnection

Gets the call identifier.

Specified by:

getCallIdentifierHex in interface MgcpConnection

Returns:

The connection identifier, in base 16

getMode

public ConnectionMode getMode()

Description copied from interface: MgcpConnection

Gets the current mode of the connection.

Specified by:

getMode in interface MgcpConnection

Returns:

The connection mode

getState

public MgcpConnectionState getState()

Description copied from interface: MgcpConnection

Gets the current state of the connection

Specified by:

getState in interface MgcpConnection

Returns:

The connection state

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

Parameters:

mode - The new mode of the connection

Throws:

IllegalStateException - Cannot update mode of closed connections

listen

public void listen(MgcpRequestedEvent event)
            throws UnsupportedMgcpEventException

Description copied from interface: MgcpConnection

Requests the connection to send notifications about a certain event.

Specified by:

listen in interface MgcpConnection

Parameters:

event - The event to liste to.

Throws:

UnsupportedMgcpEventException - If the connection does not support the event.

isEventSupported

protected abstract boolean isEventSupported(MgcpRequestedEvent event)

listen

protected abstract void listen(MgcpEvent event)
                        throws UnsupportedMgcpEventException

Throws:

UnsupportedMgcpEventException

getAudioComponent

public abstract AudioComponent getAudioComponent()

Description copied from interface: MgcpConnection

Gets the in-band audio component of the connection.

Specified by:

getAudioComponent in interface MgcpConnection

Returns:

The in-band media component

getOutOfBandComponent

public abstract OOBComponent getOutOfBandComponent()

Description copied from interface: MgcpConnection

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

Specified by:

getOutOfBandComponent in interface MgcpConnection

Returns:

The out-of-band media component

observe

public void observe(MgcpEventObserver observer)

Specified by:

observe in interface MgcpEventSubject

forget

public void forget(MgcpEventObserver observer)

Specified by:

forget in interface MgcpEventSubject

notify

public void notify(Object originator,
          MgcpEvent event)

Specified by:

notify in interface MgcpEventSubject

log

protected abstract org.apache.log4j.Logger log()

expireIn

protected void expireIn(int timeout)