org.mobicents.media.control.mgcp.pkg

Interface MgcpSignal

All Superinterfaces:

MgcpEventSubject

All Known Implementing Classes:

AbstractMgcpSignal, EndSignal, PlayAnnouncement, PlayCollect, PlayRecord

public interface MgcpSignal
extends MgcpEventSubject

Author:

Henrique Rosa (henrique.rosa@telestax.com)

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel() Cancels the executing signal. No action is taken if signal is not executing.
void	execute() Executes the signal.
String	getName() Gets the name of the signal which is composed of the MGCP package plus the signal name.
NotifiedEntity	getNotifiedEntity() Gets the entity which requested the notification of events resulting from the completion of the signal.
int	getRequestId() Gets the identifier of the request that submitted the signal.
SignalType	getSignalType() Gets the type of signal.
boolean	isExecuting() Gets whether the signal is currently executing.

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

forget, notify, observe

Method Detail

getName

String getName()

Gets the name of the signal which is composed of the MGCP package plus the signal name.

Returns:

The name of the signal.

getRequestId

int getRequestId()

Gets the identifier of the request that submitted the signal.

Returns:

The request identifier.

getNotifiedEntity

NotifiedEntity getNotifiedEntity()

Gets the entity which requested the notification of events resulting from the completion of the signal.

This parameter is equal to the NotifiedEntity parameter of the NotificationRequest that triggered this notification. The parameter is absent if there was no such parameter in the triggering request.

Returns:

The entity that submitted the signal. May return null if parameter was not specified in original RQNT command.

getSignalType

SignalType getSignalType()

Gets the type of signal.

Returns:

The type of the signal.

execute

void execute()

Executes the signal.

cancel

void cancel()

Cancels the executing signal.
No action is taken if signal is not executing.

isExecuting

boolean isExecuting()

Gets whether the signal is currently executing.

Returns:

true if executing; otherwise returns false