org.restcomm.media.control.mgcp.connection

Class BaseConnection

java.lang.Object

org.restcomm.media.control.mgcp.connection.BaseConnection

All Implemented Interfaces:

Connection

Direct Known Subclasses:

LocalConnectionImpl, RtpConnectionImpl

public abstract class BaseConnection
extends Object
implements Connection

Implements connection's FSM.

Author:

Oifa Yulian

Constructor Summary

Constructors

Constructor and Description
BaseConnection(int id, org.restcomm.media.scheduler.PriorityQueueScheduler scheduler) Creates basic connection implementation.

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(ConnectionListener listener)
void	bind() Initiates transition from NULL to HALF_OPEN state.
void	close() Initiates transition from any state to state NULL.
abstract AudioComponent	getAudioComponent()
String	getDescriptor()
Endpoint	getEndpoint()
int	getId()
boolean	getIsLocal() Gets whether connection should be bound to local or remote interface.
String	getLocalDescriptor()
ConnectionMode	getMode() Gets the current mode of this connection.
abstract OOBComponent	getOOBComponent()
String	getRemoteDescriptor()
ConnectionState	getState()
String	getTextualId()
void	join() Initiates transition from HALF_OPEN to OPEN state.
protected abstract void	onClosed() Called when connection is moving from OPEN state to NULL state.
protected abstract void	onCreated() Called when connection created.
protected abstract void	onFailed() Called if failure has bean detected during transition.
protected abstract void	onOpened() Called when connected moved to OPEN state.
protected void	releaseConnection(ConnectionType connectionType)
void	removeListener(ConnectionListener listener)
abstract void	setConnectionFailureListener(ConnectionFailureListener connectionFailureListener) Sets connection failure listener.
void	setEndpoint(Endpoint endpoint)
void	setIsLocal(boolean isLocal) Sets whether connection should be bound to local or remote interface.
void	setMode(ConnectionMode mode) Modify mode of this connection for all known media types.
abstract void	setOtherParty(byte[] descriptor) Joins endpoint which executes this connection with other party.
abstract void	setOtherParty(Connection other) Joins endpoint wich executes this connection with other party.
abstract void	setOtherParty(Text descriptor) Joins endpoint which executes this connection with other party.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.restcomm.media.spi.Connection

generateCname, generateOffer, getBytesReceived, getBytesTransmitted, getCname, getJitter, getPacketsReceived, getPacketsTransmitted, isAvailable

Constructor Detail

BaseConnection

public BaseConnection(int id,
              org.restcomm.media.scheduler.PriorityQueueScheduler scheduler)

Creates basic connection implementation.

Parameters:

id - the unique identifier of this connection within endpoint.

endpoint - the endpoint owner of this connection.

Method Detail

getAudioComponent

public abstract AudioComponent getAudioComponent()

getOOBComponent

public abstract OOBComponent getOOBComponent()

getId

public int getId()

Specified by:

getId in interface Connection

getTextualId

public String getTextualId()

Specified by:

getTextualId in interface Connection

getState

public ConnectionState getState()

Specified by:

getState in interface Connection

getDescriptor

public String getDescriptor()

Specified by:

getDescriptor in interface Connection

getLocalDescriptor

public String getLocalDescriptor()

Specified by:

getLocalDescriptor in interface Connection

getRemoteDescriptor

public String getRemoteDescriptor()

Specified by:

getRemoteDescriptor in interface Connection

setEndpoint

public void setEndpoint(Endpoint endpoint)

Specified by:

setEndpoint in interface Connection

getEndpoint

public Endpoint getEndpoint()

Specified by:

getEndpoint in interface Connection

addListener

public void addListener(ConnectionListener listener)

Specified by:

addListener in interface Connection

removeListener

public void removeListener(ConnectionListener listener)

Specified by:

removeListener in interface Connection

bind

public void bind()
          throws Exception

Initiates transition from NULL to HALF_OPEN state.

Throws:

Exception

join

public void join()
          throws Exception

Initiates transition from HALF_OPEN to OPEN state.

Throws:

Exception

close

public void close()

Initiates transition from any state to state NULL.

getMode

public ConnectionMode getMode()

Gets the current mode of this connection.

Specified by:

getMode in interface Connection

Returns:

integer constant indicating mode.

setMode

public void setMode(ConnectionMode mode)
             throws ModeNotSupportedException

Modify mode of this connection for all known media types.

Specified by:

setMode in interface Connection

Parameters:

mode - the new mode of the connection.

Throws:

ModeNotSupportedException

setConnectionFailureListener

public abstract void setConnectionFailureListener(ConnectionFailureListener connectionFailureListener)

Sets connection failure listener.

Specified by:

setConnectionFailureListener in interface Connection

onCreated

protected abstract void onCreated()
                           throws Exception

Called when connection created.

Throws:

Exception

onOpened

protected abstract void onOpened()
                          throws Exception

Called when connected moved to OPEN state.

Throws:

Exception

onClosed

protected abstract void onClosed()

Called when connection is moving from OPEN state to NULL state.

onFailed

protected abstract void onFailed()

Called if failure has bean detected during transition.

setOtherParty

public abstract void setOtherParty(Connection other)
                            throws IOException

Joins endpoint wich executes this connection with other party.

Specified by:

setOtherParty in interface Connection

Parameters:

other - the connection executed by other party endpoint.

Throws:

IOException

setOtherParty

public abstract void setOtherParty(byte[] descriptor)
                            throws IOException

Joins endpoint which executes this connection with other party.

Specified by:

setOtherParty in interface Connection

Parameters:

descriptor - the SDP descriptor of the other party.

Throws:

IOException

setOtherParty

public abstract void setOtherParty(Text descriptor)
                            throws IOException

Joins endpoint which executes this connection with other party.

Specified by:

setOtherParty in interface Connection

Parameters:

descriptor - the SDP descriptor of the other party.

Throws:

IOException

getIsLocal

public boolean getIsLocal()

Gets whether connection should be bound to local or remote interface.

Supported only for RTP connections.

Specified by:

getIsLocal in interface Connection

Returns:

boolean value

setIsLocal

public void setIsLocal(boolean isLocal)

Sets whether connection should be bound to local or remote interface.

Supported only for RTP connections.

Specified by:

setIsLocal in interface Connection

releaseConnection

protected void releaseConnection(ConnectionType connectionType)