Event Notification Plug-in Overview
Previous | Next |
Event Notification Plug-in Overview
To create an event notification plug-in, you must implement the GetHandledEvents and OnEvent methods on the IWMSEventNotificationPlugin interface. You must also implement the IWMSBasicPlugin interface. The GetHandledEvents method identifies the internal events that the plug-in is capable of handling. The OnEvent method identifies the action that the plug-in will take in response to an event. The following table identifies the events that an event notification plug-in can respond to.
Event | Description |
WMS_EVENT_UNKNOWN_EVENT | An unknown event occurred. |
WMS_EVENT_CONNECT | A client established a TCP connection to the server. |
WMS_EVENT_DISCONNECT | A client was disconnected from the server. |
WMS_EVENT_BEGIN_USER_SESSION | A client session began. |
WMS_EVENT_END_USER_SESSION | A client session ended. |
WMS_EVENT_DESCRIBE | A client requested a description of the content. |
WMS_EVENT_OPEN | This event is similar to the WMS_EVENT_DESCRIBE event except that WMS_EVENT_OPEN is guaranteed to be sent before the client requests specific streams from the server. |
WMS_EVENT_SELECT_STREAMS | A client selected streams from the server. |
WMS_EVENT_PLAY | A client requested that a server stream content to it. |
WMS_EVENT_PAUSE | This event is not supported. |
WMS_EVENT_STOP | The server stopped streaming a presentation to a client. |
WMS_EVENT_CLOSE | The server closed a client connection. |
WMS_EVENT_SET_PARAMETER | A client sent an RTSP SET_PARAMETER command or the HTTP/MMS equivalent. (The MMS protocol is not supported in Windows Server 2008 operating systems.) |
WMS_EVENT_GET_PARAMETER | A client sent an RTSP GET_PARAMETER command or the HTTP/MMS equivalent. (The MMS protocol is not supported in Windows Server 2008 operating systems.) |
WMS_EVENT_VALIDATE_PUSH_DISTRIBUTION | An encoder or upstream server attempted to push content to the server. |
WMS_EVENT_CREATE_DISTRIBUTION_DATA_PATH | The server created a data path for a push distribution. |
WMS_EVENT_DESTROY_DISTRIBUTION_DATA_PATH | The server removed a data path that was created for a push distribution. |
WMS_EVENT_LOG | The server logged client activity. |
WMS_EVENT_SERVER | A server event occurred. |
WMS_EVENT_PUBLISHING_POINT | The operating status of a publishing point or a property on the publishing point changed. |
WMS_EVENT_LIMIT_CHANGE | A property on the IWMSServerLimits interface or the IWMSPublishingPointLimits interface changed. |
WMS_EVENT_LIMIT_HIT | A limit specified by the IWMSServerLimits interface or IWMSPublishingPointLimits interface was hit. |
WMS_EVENT_PLUGIN | A plug-in event occurred. |
WMS_EVENT_PLAYLIST | A playlist event occurred. |
WMS_EVENT_CACHE | A cache event occurred. |
WMS_EVENT_REMOTE_CACHE_OPEN | A client attempted to open a stream on a downstream cache server. |
WMS_EVENT_REMOTE_CACHE_CLOSE | A client attempted to close a stream on a downstream cache server. |
WMS_EVENT_REMOTE_CACHE_LOG | A client submitted a log. |
- Note Event notification plug-ins and authorization plug-ins and are considered to be part of a single category called event notification and authorization, but they are different. Both plug-ins receive and respond to event notifications from the server, but each plug-in handles a different type of event. Authorization events pertain to client requests that must be authorized. Notification events only indicate that a specific event occurred. Authorization plug-ins must either authorize or reject the request indicated by the authorization event. Event notification plug-ins do not perform authorization.
See Also (General)
See Also (Visual Basic .NET)
- IWMSBasicPlugin Object (Visual Basic .NET)
- IWMSEventNotificationPlugin.GetHandledEvents (Visual Basic .NET)
- IWMSEventNotificationPlugin.OnEvent (Visual Basic .NET)
See Also (C#)
- IWMSBasicPlugin Object (C#)
- IWMSEventNotificationPlugin.GetHandledEvents (C#)
- IWMSEventNotificationPlugin.OnEvent (C#)
See Also (C++)
- IWMSBasicPlugin Interface
- IWMSEventNotificationPlugin::GetHandledEvents
- IWMSEventNotificationPlugin::OnEvent
Previous | Next |