(Page 10 of 12 in this chapter)
Version
mgcSignalDone
Description
Informs the MGCP service that the application stopped generating a signal.
Prototype
DWORD
mgcSignalDone
(
CTAHD
ctahd
,
char
*
epname
,
char
*
signalname
,
int
response_code
)
ctahd
Context handle associated with the gateway application.
epname
Pointer to an endpoint name. This string cannot include wild cards.
signalname
Pointer to a signal name that identifies the event condition that is no longer being detected. The
signalname
is a combination of the package and signal IDs.
response_code
Response code to return to the call agent that requested the signal. The
response_code
can be one of the following:
MGC_CODE_DONE
MGC_CODE_FAIL
MGC_CODE_STOPPED
Return Values
SUCCESS
CTAERR_INVALID_STATE
The MGCP service cannot process the signal because the specified endpoint is unregistered.
MGCERR_BAD_ENDPOINT
The specified endpoint is not registered with the MGCP service.
MGCERR_INVALID_STATE
Wrong signal or event processing state.
MGCERR_NOT_GW_HANDLE
The specified
ctahd
is not the handle associated with the application.
Events
None.
Details
Applications invoke this function when they have stopped generating a signal specified with
mgcDefinePackage
. This function specifies that the application is no longer generating a signal that was requested by the call agent and communicated to the application through an
MGC_SIGNAL_ON_REQUEST
event.
The application calls
mgcSignalDone
to notify the MGCP service when it stops generating the signal for any reason. For example:
When the signal terminates normally.
When the signal process is terminated at the explicit request of the call agent (that is, the application has received a
MGC_SIGNAL_OFF_REQUEST
event).
When the application is unable to generate a signal for some other reason.
The response code specified by the application indicates:
Response Code
Description
MGC_CODE_DONE
The application completed generating a BR or TO signal.
MGC_CODE_STOPPED
The application stopped detecting the event condition at the explicit request of the call agent (that is, through an MGCP service
MGC_EVENT_OFF_REQUEST
event).
MGC_CODE_FAIL
The application stopped generating the signal for some other reason.
See Also
mgcDefinePackage
,
mgcSignalProcessed
(Page 10 of 12 in this chapter)
Version
Want to send us feedback on our documentation? Email:
Tech_Pubs@nmss.com
Copyright © 2001, NMS Communications Corporation. All rights reserved.
(Page 10 of 12 in this chapter) Version (Page 10 of 12 in this chapter) Version