org.mobicents.media.control.mgcp.connection

Interface MgcpConnection

All Superinterfaces:

MgcpEventSubject

All Known Implementing Classes:

AbstractMgcpConnection, MgcpLocalConnection, MgcpRemoteConnection

public interface MgcpConnection
extends MgcpEventSubject

Connections are created on each endpoint that will be involved in the call.

Each connection will be designated locally by an endpoint unique connection identifier, and will be characterized by connection attributes.

Author:

Henrique Rosa (henrique.rosa@telestax.com)

See Also:

RFC3435 - Section 2.1.3

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.
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.
OOBComponent	getOutOfBandComponent() Gets the out-of-band audio component of the connection.
MgcpConnectionState	getState() Gets the current state 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	listen(MgcpRequestedEvent event) Requests the connection to send notifications about a certain event.
String	open(String sdp) Moves the connection to an open state.
void	setMode(ConnectionMode mode) Sets the mode of the connection.

Methods inherited from interface org.mobicents.media.control.mgcp.pkg.MgcpEventSubject

forget, notify, observe

Method Detail

getIdentifier

int getIdentifier()

Gets the connection identifier.

Returns:

The connection identifier, in base 10

getHexIdentifier

String getHexIdentifier()

Gets the connection identifier.

Returns:

The connection identifier, in base 16.

getCallIdentifier

int getCallIdentifier()

Gets the call identifier.

Returns:

The call identifier, in base 10

getCallIdentifierHex

String getCallIdentifierHex()

Gets the call identifier.

Returns:

The connection identifier, in base 16

isLocal

boolean isLocal()

Gets whether the connection is local or remote.

Returns:

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

getMode

ConnectionMode getMode()

Gets the current mode of the connection.

Returns:

The connection mode

getState

MgcpConnectionState getState()

Gets the current state of the connection

Returns:

The connection state

setMode

void setMode(ConnectionMode mode)
             throws IllegalStateException

Sets the mode of the connection.

Parameters:

mode - The new mode of the connection

Throws:

IllegalStateException - Cannot update mode of closed connections

halfOpen

String halfOpen(LocalConnectionOptions options)
                throws MgcpConnectionException

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.

MgcpConnectionException - If connection could not bind required resources

open

String open(String sdp)
            throws MgcpConnectionException

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.

MgcpConnectionException - If connection fails to open properly

close

void close()
           throws MgcpConnectionException

Closes the connection.

Throws:

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

listen

void listen(MgcpRequestedEvent event)
            throws UnsupportedMgcpEventException

Requests the connection to send notifications about a certain event.

Parameters:

event - The event to liste to.

Throws:

UnsupportedMgcpEventException - If the connection does not support the event.

getAudioComponent

AudioComponent getAudioComponent()

Gets the in-band audio component of the connection.

Returns:

The in-band media component

getOutOfBandComponent

OOBComponent getOutOfBandComponent()

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

Returns:

The out-of-band media component