org.mobicents.media.control.mgcp.connection.MgcpConnection Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mgcp2 Show documentation
There is a newer version: 6.0.23
/*
 * TeleStax, Open Source Cloud Communications
 * Copyright 2011-2016, Telestax Inc and individual contributors
 * by the @authors tag. 
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.mobicents.media.control.mgcp.connection;

import org.mobicents.media.control.mgcp.exception.MgcpConnectionException;
import org.mobicents.media.control.mgcp.exception.UnsupportedMgcpEventException;
import org.mobicents.media.control.mgcp.message.LocalConnectionOptions;
import org.mobicents.media.control.mgcp.pkg.MgcpEventSubject;
import org.mobicents.media.control.mgcp.pkg.MgcpRequestedEvent;
import org.mobicents.media.server.spi.ConnectionMode;
import org.mobicents.media.server.component.audio.AudioComponent;
import org.mobicents.media.server.component.oob.OOBComponent;

/**
 * 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 ([email protected])
 *
 * @see RFC3435 - Section 2.1.3
 */
public interface MgcpConnection extends MgcpEventSubject {

    /**
     * Gets the connection identifier.
     * 
     * @return The connection identifier, in base 10
     */
    int getIdentifier();

    /**
     * Gets the connection identifier.
     * 
     * @return The connection identifier, in base 16.
     */
    String getHexIdentifier();

    /**
     * Gets the call identifier.
     * 
     * @return The call identifier, in base 10
     */
    int getCallIdentifier();

    /**
     * Gets the call identifier.
     * 
     * @return The connection identifier, in base 16
     */
    String getCallIdentifierHex();

    /**
     * Gets whether the connection is local or remote.
     * 
     * @return true if connection is local; false if it is remote.
     */
    boolean isLocal();

    /**
     * Gets the current mode of the connection.
     * 
     * @return The connection mode
     */
    ConnectionMode getMode();

    /**
     * Gets the current state of the connection
     * 
     * @return The connection state
     */
    MgcpConnectionState getState();

    /**
     * Sets the mode of the connection.
     * 
     * @param mode The new mode of the connection
     * 
     * @throws IllegalStateException Cannot update mode of closed connections
     */
    void setMode(ConnectionMode mode) throws IllegalStateException;

    /**
     * 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.
     * 
     * 
     * @param options The options that configure the connection.
     * 
     * @return The SDP offer.
     * 
     * @throws MgcpConnectionException If connection state is not closed.
     * @throws MgcpConnectionException If connection could not bind required resources
     */
    String halfOpen(LocalConnectionOptions options) 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.
     * 
     * 
     * @param sdp The SDP description of the remote peer.
     * @return The SDP answer if the call is inbound; null if call is outbound.
     * 
     * @throws MgcpConnectionException If connection state is not closed nor half-open.
     * @throws MgcpConnectionException If connection fails to open properly
     */
    String open(String sdp) throws MgcpConnectionException;

    /**
     * Closes the connection.
     * 
     * @throws MgcpConnectionException If connection state is not half-open nor open.
     */
    void close() throws MgcpConnectionException;

    /**
     * Requests the connection to send notifications about a certain event.
     * 
     * @param event The event to liste to.
     * @throws UnsupportedMgcpEventException If the connection does not support the event.
     */
    void listen(MgcpRequestedEvent event) throws UnsupportedMgcpEventException;

    /**
     * Gets the in-band audio component of the connection.
     * 
     * @return The in-band media component
     */
    AudioComponent getAudioComponent();

    /**
     * Gets the out-of-band audio component of the connection.
     * 
     * @return The out-of-band media component
     */
    OOBComponent getOutOfBandComponent();

}