org.mobicents.media.control.mgcp.endpoint

Interface MgcpEndpoint

All Superinterfaces:

MgcpEndpointSubject, MgcpEventObserver, MgcpMessageSubject

All Known Implementing Classes:

GenericMgcpEndpoint, MgcpMixerEndpoint, MgcpSplitterEndpoint

public interface MgcpEndpoint
extends MgcpEndpointSubject, MgcpMessageSubject, MgcpEventObserver

An Endpoint is a logical representation of a physical entity, such as an analog phone or a channel in a trunk.

Endpoints are sources or sinks of data and can be physical or virtual. Physical endpoint creation requires hardware installation while software is sufficient for creating a virtual Endpoint.

An interface on a gateway that terminates a trunk connected to a PSTN switch is an example of a physical Endpoint. An audio source in an audio-content server is an example of a virtual Endpoint.

Author:

Henrique Rosa (henrique.rosa@telestax.com)

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelSignal(String signal) Attempts to cancel an active signal in the endpoint.
MgcpConnection	createConnection(int callId, boolean local) Registers a connection.
MgcpConnection	deleteConnection(int callId, int connectionId) Deletes an active connection.
List<MgcpConnection>	deleteConnections() Deletes all currently active connections.
List<MgcpConnection>	deleteConnections(int callId) Deletes all currently active connections within a specific call.
MgcpConnection	getConnection(int callId, int connectionId) Gets a connection by identifier.
EndpointIdentifier	getEndpointId() Gets the endpoint identifier
MediaGroup	getMediaGroup() Gets the media group that holds media components of the endpoint.
void	requestNotification(NotificationRequest request) Requests a notification to be fired when an event happens in the endpoint.

Methods inherited from interface org.mobicents.media.control.mgcp.endpoint.MgcpEndpointSubject

forget, notify, observe

Methods inherited from interface org.mobicents.media.control.mgcp.message.MgcpMessageSubject

forget, notify, observe

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

onEvent

Method Detail

getEndpointId

EndpointIdentifier getEndpointId()

Gets the endpoint identifier

Returns:

The endpoint ID

getConnection

MgcpConnection getConnection(int callId,
                           int connectionId)

Gets a connection by identifier.

Parameters:

callId - The call identifier.

connectionId - The connection identifier.

Returns:

The connection matching the criteria. Returns null if no such connection exists.

createConnection

MgcpConnection createConnection(int callId,
                              boolean local)

Registers a connection.

Parameters:

callId - The identifier of the call where the connection belongs to.

local - Whether a local or remote connection is to be created.

deleteConnection

MgcpConnection deleteConnection(int callId,
                              int connectionId)
                                throws MgcpCallNotFoundException,
                                       MgcpConnectionNotFoundException

Deletes an active connection.

Parameters:

callId - The ID of the call where the connection is stored.

connectionId - The connection ID

Throws:

MgcpCallNotFoundException - When call with such ID cannot be found.

MgcpConnectionNotFoundException - When call does not contain connection with such ID.

deleteConnections

List<MgcpConnection> deleteConnections()

Deletes all currently active connections.

deleteConnections

List<MgcpConnection> deleteConnections(int callId)
                                       throws MgcpCallNotFoundException

Deletes all currently active connections within a specific call.

Parameters:

callId - the call identifier

Throws:

MgcpCallNotFoundException - When call with such ID cannot be found.

requestNotification

void requestNotification(NotificationRequest request)

Requests a notification to be fired when an event happens in the endpoint.

Parameters:

request - The notification request.

cancelSignal

void cancelSignal(String signal)

Attempts to cancel an active signal in the endpoint.

Parameters:

signal - The name of the signal.

getMediaGroup

MediaGroup getMediaGroup()

Gets the media group that holds media components of the endpoint.

Returns:

The media group.