[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Main class for the Event Router

Namespace: Microsoft.WebSolutionsPlatform.Event
Assembly: WspEventRouter (WspEventRouter)

Syntax

Visual Basic (Declaration)
Public Class Router _
	Inherits ServiceBase
C#
public class Router : ServiceBase
C++
public ref class Router : public ServiceBase

Methods

IconTypeDescription
static memberConcatArrayList(ArrayList)
Concatenates an ArrayList of byte[] and returns one byte[]
CreateObjRef(Type)
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
Dispose(Boolean)
Clean up any resources being used.
Equals(Object)
Determines whether the specified Object is equal to the current Object.
Finalize()
Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.
GetHashCode()
Serves as a hash function for a particular type. GetHashCode() is suitable for use in hashing algorithms and data structures like a hash table.
GetLifetimeService()
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
GetService(Type)
Returns an object that represents a service provided by the Component or by its Container.
GetType()
Gets the Type of the current instance.
InitializeLifetimeService()
Obtains a lifetime service object to control the lifetime policy for this instance.
MemberwiseClone(Boolean)
Creates a shallow copy of the current MarshalByRefObject object.
OnContinue()
When implemented in a derived class, OnContinue() runs when a Continue command is sent to the service by the Service Control Manager (SCM). Specifies actions to take when a service resumes normal functioning after being paused.
OnCustomCommand(Int32)
When implemented in a derived class, OnCustomCommand(Int32) executes when the Service Control Manager (SCM) passes a custom command to the service. Specifies actions to take when a command with the specified parameter value occurs.
OnPause()
When implemented in a derived class, executes when a Pause command is sent to the service by the Service Control Manager (SCM). Specifies actions to take when a service pauses.
OnPowerEvent(PowerBroadcastStatus)
When implemented in a derived class, executes when the computer's power status has changed. This applies to laptop computers when they go into suspended mode, which is not the same as a system shutdown.
OnSessionChange(SessionChangeDescription)
Executes when a change event is received from a Terminal Server session.
OnShutdown()
When implemented in a derived class, executes when the system is shutting down. Specifies what should happen immediately prior to the system shutting down.
OnStart(String[]())
Implements the OnStart for the service
OnStop()
Implements the OnStop for the service
RequestAdditionalTime(Int32)
Requests additional time for a pending operation.
ServiceMainCallback(Int32, IntPtr)
Registers the command handler and starts the service.
Stop()
Stops the executing service.
ToString()
Returns a String containing the name of the Component, if any. This method should not be overridden.

Constructors

IconTypeDescription
RouterNew()
Default constructor for the Router class

Properties

IconTypeDescription
AutoLog
Indicates whether to report Start, Stop, Pause, and Continue commands in the event log.
CanHandlePowerEvent
Gets or sets a value indicating whether the service can handle notifications of computer power status changes.
CanHandleSessionChangeEvent
Gets or sets a value that indicates whether the service can handle session change events received from a Terminal Server session.
CanPauseAndContinue
Gets or sets a value indicating whether the service can be paused and resumed.
CanRaiseEvents
Gets a value indicating whether the component can raise an event.
CanShutdown
Gets or sets a value indicating whether the service should be notified when the system is shutting down.
CanStop
Gets or sets a value indicating whether the service can be stopped once it has started.
Container
Gets the IContainer that contains the Component.
DesignMode
Gets a value that indicates whether the Component is currently in design mode.
EventLog
Gets an event log you can use to write notification of service command calls, such as Start and Stop, to the Application event log.
Events
Gets the list of event handlers that are attached to this Component.
ExitCode
Gets or sets the exit code for the service.
ServiceHandle
Gets the service control handle for the service.
ServiceName
Gets or sets the short name used to identify the service to the system.
Site
Gets or sets the ISite of the Component.

Events

IconTypeDescription
Disposed
Adds an event handler to listen to the Disposed event on the component.

Inheritance Hierarchy

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      System.ServiceProcess.ServiceBase
        Microsoft.WebSolutionsPlatform.Event.Router