org.mobicents.media.server.spi.Connection Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spi Show documentation
There is a newer version: 6.0.23
/*
 * JBoss, Home of Professional Open Source
 * Copyright 2011, Red Hat, Inc. and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * 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.server.spi;

import java.io.IOException;

import org.mobicents.media.server.utils.Text;

/**
 *
 * @author Yulian Oifa
 * @author amit bhayani
 * @author Henrique Rosa ([email protected])
 */
public interface Connection {
	/**
	 * Gets the identifier of this connection.
	 *
	 * @return integer.
	 */
	public int getId();

	/**
	 * Gets the identifier of this connection.
	 *
	 * @return hex view of the integer.
	 */
	public String getTextualId();

	/**
	 * Gets whether connection should be bound to local or remote interface ,
	 * supported only for rtp connections.
	 *
	 * @return boolean value
	 */
	public boolean getIsLocal();

	/**
	 * Gets whether connection should be bound to local or remote interface ,
	 * supported only for rtp connections.
	 *
	 * @return boolean value
	 */
	public void setIsLocal(boolean isLocal);

	/**
	 * Returns state of this connection
	 * 
	 * @return
	 */
	public ConnectionState getState();

	/**
	 * Gets the current mode of this connection.
	 *
	 * @return integer constant indicating mode.
	 */
	public ConnectionMode getMode();

	/**
	 * Modify mode of this connection for all known media types.
	 * 
	 * @param mode
	 *            the new mode of the connection.
	 */
	public void setMode(ConnectionMode mode) throws ModeNotSupportedException;

	/**
	 * Sets the endpoint which executes this connection.
	 *
	 * @param the
	 *            endpoint object.
	 */
	public void setEndpoint(Endpoint endpoint);

	/**
	 * Gets the endpoint which executes this connection.
	 *
	 * @return the endpoint object.
	 */
	public Endpoint getEndpoint();

	/**
	 * Gets the descriptor of this connection in SDP format.
	 * 
	 * @return SDP descriptor as text string.
	 */
	public String getDescriptor();

	/**
	 * Gets the local descriptor of this connection in SDP format
	 * 
	 * @return The local SDP descriptor. Returns an empty string if not
	 *         available.
	 */
	public String getLocalDescriptor();

	/**
	 * Gets the remote descriptor of this connection in SDP format
	 * 
	 * @return The remote SDP descriptor. Returns an empty string if not
	 *         available.
	 */
	public String getRemoteDescriptor();

    /**
     * Generates the local connection descriptor and allocates the necessary resources.
     * 
     * @param webrtc Whether the offer should be WebRTC compatible or not.
     * @throws IOException
     */
    public void generateOffer(boolean webrtc) throws IOException;

	/**
	 * Joins endpoint wich executes this connection with other party.
	 *
	 * @param other
	 *            the connection executed by other party endpoint.
	 * @throws IOException
	 */
	public void setOtherParty(Connection other) throws IOException;

	/**
	 * Joins endpoint which executes this connection with other party.
	 *
	 * @param descriptor
	 *            the SDP descriptor of the other party.
	 * @throws IOException
	 */
	public void setOtherParty(byte[] descriptor) throws IOException;

	/**
	 * Joins endpoint which executes this connection with other party.
	 *
	 * @param descriptor
	 *            the SDP descriptor of the other party.
	 * @throws IOException
	 */
	public void setOtherParty(Text descriptor) throws IOException;

	/**
	 * Adds connection state listener.
	 * 
	 * @param listener
	 *            to be registered
	 */
	public void addListener(ConnectionListener listener);

	/**
	 * Sets connection failure listener.
	 * 
	 * @param listener
	 *            to be registered
	 */
	public void setConnectionFailureListener(
			ConnectionFailureListener connectionFailureListener);

	/**
	 * Removes connection state listener.
	 * 
	 * @param listener
	 *            to be unregistered
	 */
	public void removeListener(ConnectionListener listener);

	/**
	 * The number of packets of the specified media type received .
	 * 
	 * @param media
	 *            the media type.
	 * @return the number of packets.
	 */
	public long getPacketsReceived();

	/**
	 * The total number of bytes received .
	 * 
	 * @return the number of bytes.
	 */
	public long getBytesReceived();

	/**
	 * The number of packets of the specified media type transmitted.
	 * 
	 * @param media
	 *            the media type
	 * @return the number of packets.
	 */
	public long getPacketsTransmitted();

	/**
	 * The total number of bytes transmitted.
	 * 
	 * @return the number of bytes.
	 */
	public long getBytesTransmitted();

	/**
	 * The average jitter value accross all media types.
	 * 
	 * @return average jitter value.
	 */
	public double getJitter();

	/**
	 * Checks whether a connection has finished gathering all necessary
	 * resources and is ready to use.
	 * 
	 * @return whether connection is available
	 */
	public boolean isAvailable();

	/**
	 * Generates a unique CNAME for the connection and its channels.

	 * Only applicable to RTP connections!
	 */
	public void generateCname();

	/**
	 * Gets the CNAME of the connection. Only applicable to RTP connections!
	 * 
	 * @return The unique CNAME that identifies the connection and its channels.
	 */
	public String getCname();
}