Space Engineers
Public Member Functions | Protected Member Functions | List of all members
VRage.Dedicated.WindowsService Class Reference
Inheritance diagram for VRage.Dedicated.WindowsService:
VRage.Service.MyServiceBase

Public Member Functions

 WindowsService ()
 Public Constructor for WindowsService. More...
 
- Public Member Functions inherited from VRage.Service.MyServiceBase
 MyServiceBase ()
 
unsafe void RequestAdditionalTime (int milliseconds)
 
void Stop ()
 
unsafe void ServiceMainCallback (int argCount, IntPtr argPointer)
 

Protected Member Functions

override void Dispose (bool disposing)
 Dispose of objects that need it here. More...
 
override void OnStart (string[] args)
 OnStart(): Put startup code here More...
 
override void OnStop ()
 OnStop(): Put your stop code here More...
 
override void OnPause ()
 OnPause: Put your pause code here More...
 
override void OnContinue ()
 OnContinue(): Put your continue code here More...
 
override void OnShutdown ()
 OnShutdown(): Called when the System is shutting down More...
 
override void OnCustomCommand (int command)
 OnCustomCommand(): If you need to send a command to your service without the need for Remoting or Sockets, use this method to do custom methods. More...
 
override bool OnPowerEvent (PowerBroadcastStatus powerStatus)
 OnPowerEvent(): Useful for detecting power status changes, such as going into Suspend mode or Low Battery for laptops. More...
 
override void OnSessionChange (SessionChangeDescription changeDescription)
 OnSessionChange(): To handle a change event from a Terminal Server session. Useful if you need to determine when a user logs in remotely or logs off, or when someone logs into the console. More...
 
- Protected Member Functions inherited from VRage.Service.MyServiceBase
override void Dispose (bool disposing)
 

Additional Inherited Members

- Static Public Member Functions inherited from VRage.Service.MyServiceBase
static void Run (MyServiceBase[] services)
 
static void Run (MyServiceBase service)
 
- Public Attributes inherited from VRage.Service.MyServiceBase
const int MaxNameLength = 80
 
- Properties inherited from VRage.Service.MyServiceBase
string UsedServiceName [get]
 
bool AutoLog [get, set]
 
int ExitCode [get, set]
 
bool CanHandlePowerEvent [get, set]
 
bool CanHandleSessionChangeEvent [get, set]
 
bool CanPauseAndContinue [get, set]
 
bool CanShutdown [get, set]
 
bool CanStop [get, set]
 
virtual EventLog EventLog [get]
 
IntPtr ServiceHandle [get]
 
string ServiceName [get, set]
 

Detailed Description

Definition at line 16 of file WindowsService.cs.

Constructor & Destructor Documentation

VRage.Dedicated.WindowsService.WindowsService ( )
inline

Public Constructor for WindowsService.

  • Put all of your Initialization code here.

Definition at line 25 of file WindowsService.cs.

Member Function Documentation

override void VRage.Dedicated.WindowsService.Dispose ( bool  disposing)
inlineprotected

Dispose of objects that need it here.

Parameters
disposingWhether or not disposing is going on.

Definition at line 50 of file WindowsService.cs.

override void VRage.Dedicated.WindowsService.OnContinue ( )
inlineprotectedvirtual

OnContinue(): Put your continue code here

  • Un-pause working threads, etc.

Reimplemented from VRage.Service.MyServiceBase.

Definition at line 112 of file WindowsService.cs.

override void VRage.Dedicated.WindowsService.OnCustomCommand ( int  command)
inlineprotectedvirtual

OnCustomCommand(): If you need to send a command to your service without the need for Remoting or Sockets, use this method to do custom methods.

Parameters
commandArbitrary Integer between 128 & 256

Reimplemented from VRage.Service.MyServiceBase.

Definition at line 134 of file WindowsService.cs.

override void VRage.Dedicated.WindowsService.OnPause ( )
inlineprotectedvirtual

OnPause: Put your pause code here

  • Pause working threads, etc.

Reimplemented from VRage.Service.MyServiceBase.

Definition at line 103 of file WindowsService.cs.

override bool VRage.Dedicated.WindowsService.OnPowerEvent ( PowerBroadcastStatus  powerStatus)
inlineprotectedvirtual

OnPowerEvent(): Useful for detecting power status changes, such as going into Suspend mode or Low Battery for laptops.

Parameters
powerStatusThe Power Broadcast Status (BatteryLow, Suspend, etc.)

Reimplemented from VRage.Service.MyServiceBase.

Definition at line 150 of file WindowsService.cs.

override void VRage.Dedicated.WindowsService.OnSessionChange ( SessionChangeDescription  changeDescription)
inlineprotectedvirtual

OnSessionChange(): To handle a change event from a Terminal Server session. Useful if you need to determine when a user logs in remotely or logs off, or when someone logs into the console.

Parameters
changeDescriptionThe Session Change Event that occured.

Reimplemented from VRage.Service.MyServiceBase.

Definition at line 164 of file WindowsService.cs.

override void VRage.Dedicated.WindowsService.OnShutdown ( )
inlineprotectedvirtual

OnShutdown(): Called when the System is shutting down

  • Put code here when you need special handling of code that deals with a system shutdown, such as saving special data before shutdown.

Reimplemented from VRage.Service.MyServiceBase.

Definition at line 123 of file WindowsService.cs.

override void VRage.Dedicated.WindowsService.OnStart ( string[]  args)
inlineprotectedvirtual

OnStart(): Put startup code here

  • Start threads, get inital data, etc.
Parameters
args

Reimplemented from VRage.Service.MyServiceBase.

Definition at line 60 of file WindowsService.cs.

override void VRage.Dedicated.WindowsService.OnStop ( )
inlineprotectedvirtual

OnStop(): Put your stop code here

  • Stop threads, set final data, etc.

Reimplemented from VRage.Service.MyServiceBase.

Definition at line 87 of file WindowsService.cs.


The documentation for this class was generated from the following file: