org.mobicents.media.control.mgcp.call

Class MgcpCall

java.lang.Object

org.mobicents.media.control.mgcp.call.MgcpCall

public class MgcpCall
extends Object

A Call is responsible to group Connections that belong to the same session.

The concept of Call has little semantic meaning in the MGCP protocol. However, it can be used to identify calls for reporting and accounting purposes. It does not affect the handling of connections by the gateway.

Calls are identified by unique identifiers, independent of the underlying platforms or agents.
Call identifiers are hexadecimal strings, which are created by the Call Agent. The maximum length of call identifiers is 32 characters.

Author:

Henrique Rosa (henrique.rosa@telestax.com)

Constructor Summary

Constructors

Constructor and Description
MgcpCall(int callId)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addConnection(String endpointId, int connectionId) Registers a connection in the call.
int	getCallId() Gets the call identifier.
String	getCallIdHex() Gets the call identifier.
Set<Integer>	getConnections(String endpointId) Gets the list of currently registered connections in the Call.
Set<String>	getEndpoints() Gets the list of currently registered endpoints that own the connections in the Call.
boolean	removeConnection(String endpointId, int connectionId) Unregisters a connection from the call.
Set<Integer>	removeConnections(String endpointId) Unregisters all connections that belong to an endpoint.

Methods inherited from class java.lang.Object

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

Constructor Detail

MgcpCall

public MgcpCall(int callId)

Method Detail

getCallId

public int getCallId()

Gets the call identifier.

Returns:

The call identifier in base 10.

getCallIdHex

public String getCallIdHex()

Gets the call identifier.

Returns:

The call identifier in base 16.

getEndpoints

public Set<String> getEndpoints()

Gets the list of currently registered endpoints that own the connections in the Call.

Returns:

An unmodifiable set of endpoint identifiers. If no endpoints are registered, an empty set is returned.

getConnections

public Set<Integer> getConnections(String endpointId)

Gets the list of currently registered connections in the Call.

Returns:

An unmodifiable set of connection identifiers. If no connections are registered, an empty set is returned.

addConnection

public boolean addConnection(String endpointId,
                    int connectionId)

Registers a connection in the call.

Parameters:

endpointId - The identifier of the endpoint that owns the connection.

connectionId - The connection identifier.

Returns:

Returns true if connection was successfully registered. Returns false otherwise.

removeConnection

public boolean removeConnection(String endpointId,
                       int connectionId)

Unregisters a connection from the call.

Parameters:

endpointId - The identifier of the endpoint that owns the connection.

connectionId - The connection identifier.

Returns:

Returns true if connection was removed successfully. Returns false otherwise.

removeConnections

public Set<Integer> removeConnections(String endpointId)

Unregisters all connections that belong to an endpoint.

Parameters:

endpointId - The identifier of the endpoint that owns the connections.

Returns:

A set containing all unregistered connection identifiers. Returns an empty set if no connections exist.