Qbik Helpsys

Managing the WinGate Engine

WinGate events

License restriction: Events registered by the WinGate Engine are only available with a WinGate Enterprise license.

WinGate currently registers a small range of events with the Events system that can take place round the operation of the WinGate Engine. Like other registered events, you can specify which and how each event processor will respond to them taking place from the Events panel, located at Control Panel > Events in the WinGate Management console.

  • WinGate:Shutdown

    This event occurs immediately before the WinGate Engine shuts down.

  • WinGate:ShutdownCancelled

    This event occurs when a shut down or restart of the WinGate Engine is cancelled.

  • WinGate:Start

    This event occurs immediately after the WinGate Engine has restarted.

These WinGate events provide ideal opportunities in the operation of the WinGate Engine, for you to perform maintenance tasks such as executing a script, processing a policy, or sending an email to alert the administrator of these events taking place.

WinGate objects

License restriction: The WinGate object registered by the WinGate Engine is only available with a WinGate Enterprise license.

When you are using a WinGate script system (such as the Run Lua script or Run Javascript event processors) or a WinGate configuration that has access to the Symbol Browser, you can use the WinGate object registered by the WinGate Engine, to provide access to information about a WinGate installation and control the operation of the WinGate Engine.

WinGate object

Member

Description

Computername

The name of the computer that WinGate is running on.

Restart(Text Reason)

Shutdown and restart the WinGate Engine.

e.g. A script could contain:

WinGate.Restart("Maintenance restart")

This would shutdown and restart the WinGate Engine when the script is run. The reason for the restart (Maintenance restart) would be logged to the log file that the WinGate Engine has been configured to supply diagnostic information to.

Shutdown(Text Reason)

Stop the WinGate Engine.

Sleep(Number Delay)

Delay processing for a certain time (ms).

Version

The version of WinGate running.

  1. no comments yet...

Download helpfile

You can use basic Full-Text Searches against the page title and body to find matching articles. Use the following search modifiers to refine your query:

  • event management (no quotes) will find all pages containing the words "event" OR "management"
  • "event management" (with quotes) will find all pages containing the phrase "event management"
  • +event -management will find all pages containing the word "event", AND NOT the word "management"