Appendix B

Events and Reasons

In response to commands executed by an application, the MGCP service generates events and reason codes that indicate certain conditions or state changes. This appendix is a summary of the events and reason codes generated by the MGCP service.

A DONE event is a Natural Access event informing the application that an asynchronous function has completed processing. DONE event codes are in the form MGCEVN_function_DONE where function is the completed function (for example, REGISTER_ENDPOINT or UNREGISTER_ENDPOINT). DONE events have no special physical or processing characteristics; they have the same physical structure and are retrieved identically as all other events.

The following table provides an alphabetical listing of MGCP service events and their descriptions: Event Name Description MGCEVN_EVENT_OFF_REQUEST The call agent requests that the application cease listening for particular event. MGCEVN_EVENT_ON_REQUEST The call agent requests that the application begin listening for particular event. MGCEVN_REGISTER_ENDPOINT_DONE The MGCP service completed (successfully or unsuccessfully) the process of registering an endpoint. MGCEVN_SIGNAL_OFF_REQUEST The call agent requests that the application stop generating a specific signal. MGCEVN_SIGNAL_ON_REQUEST The call agent requests that the application begin generate a specific signal. MGCEVN_UNREGISTER_ENDPOINT_DONE The MGCP service has completed (successfully or unsuccessfully) the process of unregistering an endpoint

Event Name	Description
MGCEVN_EVENT_OFF_REQUEST	The call agent requests that the application cease listening for particular event.
MGCEVN_EVENT_ON_REQUEST	The call agent requests that the application begin listening for particular event.
MGCEVN_REGISTER_ENDPOINT_DONE	The MGCP service completed (successfully or unsuccessfully) the process of registering an endpoint.
MGCEVN_SIGNAL_OFF_REQUEST	The call agent requests that the application stop generating a specific signal.
MGCEVN_SIGNAL_ON_REQUEST	The call agent requests that the application begin generate a specific signal.
MGCEVN_UNREGISTER_ENDPOINT_DONE	The MGCP service has completed (successfully or unsuccessfully) the process of unregistering an endpoint

The following table provides a list of events in numerical order: Hex Decimal Event Name 0x00472101 4661505 MGCEVN_REGISTER_ENDPOINT_DONE 0x00472102 4661506 MGCEVN_UNREGISTER_ENDPOINT_DONE 0x00472106 4661510 MGCEVN_SIGNAL_OFF_REQUEST 0x00472107 4661511 MGCEVN_SIGNAL_ON_REQUEST 0x00472108 4661512 MGCEVN_EVENT_OFF_REQUEST 0x00472109 4661513 MGCEVN_EVENT_ON_REQUEST 0x0047210a 4661514 MGCEVN_INTERNAL_ERROR

Hex	Decimal	Event Name
0x00472101	4661505	MGCEVN_REGISTER_ENDPOINT_DONE
0x00472102	4661506	MGCEVN_UNREGISTER_ENDPOINT_DONE
0x00472106	4661510	MGCEVN_SIGNAL_OFF_REQUEST
0x00472107	4661511	MGCEVN_SIGNAL_ON_REQUEST
0x00472108	4661512	MGCEVN_EVENT_OFF_REQUEST
0x00472109	4661513	MGCEVN_EVENT_ON_REQUEST
0x0047210a	4661514	MGCEVN_INTERNAL_ERROR

Reason codes are generated when a DONE event is returned, but an associated task has failed.

Reason Code	Description
MGC_REASON_BAD_MSPHD	The specified endpoint handle was not a valid MSPP endpoint handle (*ephd*).
MGC_REASON_EP_DONE	The MGCP successfully unregistered one of the specified MGCP endpoints. However, the MGCP service is still in the process of unregistering other endpoints that are referenced to by wild cards.
MGC_REASON_MSP_ENDPOINT_FAILED	The MGCP service cannot create an endpoint to associate with the MGCP endpoint or destroy the MSPP endpoint associated with the MGCP endpoint.
MGC_REASON_NO_MSP	The MSPP service is not started on the specified *ctahd.*
MGC_REASON_NO_RESOURCES	The MGCP service is unable to allocate sufficient on-board resources to register the endpoint.

The following table provides a list of reason codes in numerical order: Hex Decimal Event Name 0x00471001 4657153 MGC_REASON_NO_RESOURCES 0x00471002 4657154 MGC_REASON_NO_MSP 0x00471003 4657155 MGC_REASON_BAD_MSPHD 0x00471004 4657156 MGC_REASON_EP_DONE 0x00471005 4657157 MGC_REASON_MSP_ENDPOINT_FAILED

Hex	Decimal	Event Name
0x00471001	4657153	MGC_REASON_NO_RESOURCES
0x00471002	4657154	MGC_REASON_NO_MSP
0x00471003	4657155	MGC_REASON_BAD_MSPHD
0x00471004	4657156	MGC_REASON_EP_DONE
0x00471005	4657157	MGC_REASON_MSP_ENDPOINT_FAILED

Want to send us feedback on our documentation? Email: Tech_Pubs@nmss.com