Appendix B

MSPP Event Reference

In response to commands executed by an application, the MSPP service generates events and reason codes which indicate the occurrence (or lack) of certain conditions or state changes. This appendix is a summary of the events and reason codes generated by the MSPP service.

A DONE event is a CT Access event informing the application that an asynchronous function has completed processing. DONE event codes are in the form MSPEVN_function_DONE where function is the completed function (CREATE_CHANNEL, DESTROY_CHANNEL). 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 MSPP service events and their descriptions: Event Name Description MSPEVN_CONNECT_DONE Media channel has been connected to endpoints. MSPEVN_CREATE_CHANNEL_DONE Media channel has been created. MSPEVN_CREATE_ENDPOINT_DONE MSPP endpoint has been created. MSPEVN_DESTROY_CHANNEL_DONE Specified media channel has been destroyed. MSPEVN_DESTROY_ENDPOINT_DONE Specified endpoint has been destroyed. MSPEVN_DISABLE_CHANNEL_DONE Data flow through specified channel has halted. MSPEVN_DISABLE_ENDPOINT_DONE Data flow between specified endpoints has halted. MSPEVN_DISCONNECT_DONE Media channel has been disconnected from endpoints. MSPEVN_ENABLE_CHANNEL_DONE Data flow through specified channel has been enabled. MSPEVN_ENABLE_ENDPOINT_DONE Data flow between connected MSPP endpoints has been enabled. MSPEVN_QUERY_DONE The specified MSPP query has been performed.

Event Name	Description
MSPEVN_CONNECT_DONE	Media channel has been connected to endpoints.
MSPEVN_CREATE_CHANNEL_DONE	Media channel has been created.
MSPEVN_CREATE_ENDPOINT_DONE	MSPP endpoint has been created.
MSPEVN_DESTROY_CHANNEL_DONE	Specified media channel has been destroyed.
MSPEVN_DESTROY_ENDPOINT_DONE	Specified endpoint has been destroyed.
MSPEVN_DISABLE_CHANNEL_DONE	Data flow through specified channel has halted.
MSPEVN_DISABLE_ENDPOINT_DONE	Data flow between specified endpoints has halted.
MSPEVN_DISCONNECT_DONE	Media channel has been disconnected from endpoints.
MSPEVN_ENABLE_CHANNEL_DONE	Data flow through specified channel has been enabled.
MSPEVN_ENABLE_ENDPOINT_DONE	Data flow between connected MSPP endpoints has been enabled.
MSPEVN_QUERY_DONE	The specified MSPP query has been performed.

The following table provides a list of events in numerical order: Hex Decimal Event Name 0x001b2001 1777665 MSPEVN_CREATE_ENDPOINT_DONE 0x001b2002 1777666 MSPEVN_DESTROY_ENDPOINT_DONE 0x001b2003 1777667 MSPEVN_ENABLE_ENDPOINT_DONE 0x001b2004 1777668 MSPEVN_DISABLE_ENDPOINT_DONE 0x001b2005 1777669 MSPEVN_CREATE_CHANNEL_DONE 0x001b2006 1777670 MSPEVN_DESTROY_CHANNEL_DONE 0x001b2007 1777671 MSPEVN_ENABLE_CHANNEL_DONE 0x001b2008 1777672 MSPEVN_DISABLE_CHANNEL_DONE 0x001b2009 1777673 MSPEVN_CONNECT_DONE 0x001b200a 1777674 MSPEVN_DISCONNECT_DONE 0x001b2200 1778176 MSPEVN_QUERY_DONE

Hex	Decimal	Event Name
0x001b2001	1777665	MSPEVN_CREATE_ENDPOINT_DONE
0x001b2002	1777666	MSPEVN_DESTROY_ENDPOINT_DONE
0x001b2003	1777667	MSPEVN_ENABLE_ENDPOINT_DONE
0x001b2004	1777668	MSPEVN_DISABLE_ENDPOINT_DONE
0x001b2005	1777669	MSPEVN_CREATE_CHANNEL_DONE
0x001b2006	1777670	MSPEVN_DESTROY_CHANNEL_DONE
0x001b2007	1777671	MSPEVN_ENABLE_CHANNEL_DONE
0x001b2008	1777672	MSPEVN_DISABLE_CHANNEL_DONE
0x001b2009	1777673	MSPEVN_CONNECT_DONE
0x001b200a	1777674	MSPEVN_DISCONNECT_DONE
0x001b2200	1778176	MSPEVN_QUERY_DONE

Reason codes are generated when a DONE event is given, but an associated task has failed. Reason codes are in the form MSPRSN_FAILED_TO_function where function is the failed task.

The following table provides an alphabetical listing of MSPP service reason codes and their descriptions: Reason Code Description MSPRSN_FAILED_TO_ALLOCATE The MSPP service is unable to allocate on-board resources. MSPRSN_FAILED_TO_DEALLOCATE The MSPP service is unable to deallocate on-board resources. MSPRSN_FAILED_TO_INTERCONNECT The MSPP service is unable to connect the channel to an endpoint. MSPRSN_FAILED_TO_INTERDISCONNECT The MSPP service is unable to disconnect the channel from an endpoint. MSPRSN_FAILED_TO_INTRACONNECT The MSPP service is unable to connect filters within the channel. MSPRSN_FAILED_TO_INTRADISCONNECT The MSPP service is unable to disconnect filters within the channel. MSPRSN_FAILED_TO_START The MSPP service is unable to start the on-board resource. MSPRSN_FAILED_TO_STOP The MSPP service is unable to stop the on-board resource.

Reason Code	Description
MSPRSN_FAILED_TO_ALLOCATE	The MSPP service is unable to allocate on-board resources.
MSPRSN_FAILED_TO_DEALLOCATE	The MSPP service is unable to deallocate on-board resources.
MSPRSN_FAILED_TO_INTERCONNECT	The MSPP service is unable to connect the channel to an endpoint.
MSPRSN_FAILED_TO_INTERDISCONNECT	The MSPP service is unable to disconnect the channel from an endpoint.
MSPRSN_FAILED_TO_INTRACONNECT	The MSPP service is unable to connect filters within the channel.
MSPRSN_FAILED_TO_INTRADISCONNECT	The MSPP service is unable to disconnect filters within the channel.
MSPRSN_FAILED_TO_START	The MSPP service is unable to start the on-board resource.
MSPRSN_FAILED_TO_STOP	The MSPP service is unable to stop the on-board resource.

The following table provides a list of reason codes in numerical order: Hex Decimal Event Name 0x001b1001 1773569 MSPRSN_FAILED_TO_ALLOCATE 0x001b1002 1773570 MSPRSN_FAILED_TO_DEALLOCATE 0x001b1003 1773571 MSPRSN_FAILED_TO_START 0x001b1004 1773572 MSPRSN_FAILED_TO_STOP 0x001b1005 1773573 MSPRSN_FAILED_TO_INTRACONNECT 0x001b1006 1773574 MSPRSN_FAILED_TO_INTRADISCONNECT 0x001b1007 1773575 MSPRSN_FAILED_TO_INTERCONNECT 0x001b1008 1773576 MSPRSN_FAILED_TO_INTERDISCONNECT

Hex	Decimal	Event Name
0x001b1001	1773569	MSPRSN_FAILED_TO_ALLOCATE
0x001b1002	1773570	MSPRSN_FAILED_TO_DEALLOCATE
0x001b1003	1773571	MSPRSN_FAILED_TO_START
0x001b1004	1773572	MSPRSN_FAILED_TO_STOP
0x001b1005	1773573	MSPRSN_FAILED_TO_INTRACONNECT
0x001b1006	1773574	MSPRSN_FAILED_TO_INTRADISCONNECT
0x001b1007	1773575	MSPRSN_FAILED_TO_INTERCONNECT
0x001b1008	1773576	MSPRSN_FAILED_TO_INTERDISCONNECT

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