ServerBaseForm

Overview

The ServerBaseForm class is the base form for Remoting SDK-based servers. It provides some GUI features like the tray icon with its context menu, a notification balloon that is shown when this form is minimized for the very first time, etc.

To use this class, override the StartServer, StopServer and, if needed, the ShutdownServer methods and add the DoServerStart method call to start the server.

This class is used as the base GUI class in the Olympia and Relativity servers.

Location

Reference: RemObjects.SDK.Server.dll
Namespace: RemObjects.SDK.Forms
Ancestry: Form | ServerBaseForm

constructor

Creates a new instance of the ServerBaseForm class.

constructor

ServerBaseForm()

Sub New()

Dispose protected

method Dispose(disposing: Boolean)

void Dispose(Boolean disposing)

Sub Dispose(disposing As Boolean)

Parameters:

disposing:

DoShutdownServer protected

Performs server shutdown procedures (including GUI manipulations).

This method calls the ShutdownServer method to perform application-specific actions.

method DoShutdownServer

void DoShutdownServer()

Sub DoShutdownServer()

DoStartServer protected

Performs server startup procedures (including GUI manipulations).

This method calls the StartServer method to perform application-specific actions.

method DoStartServer

void DoStartServer()

Sub DoStartServer()

DoStopServer protected

Performs server stop procedures (including GUI manipulations).

This method calls the StopServer method to perform application-specific actions.

method DoStopServer

void DoStopServer()

Sub DoStopServer()

IsServerActive protected

Gets a flag indicating whether the server is active.

In the current implementation, it always returns true and should be overridden.

property IsServerActive: Boolean read;

Boolean IsServerActive { get; }

ReadOnly Property IsServerActive() As Boolean

ServerName

Get or sets the server application name (for example Relativity or Olympia State Server).

The server name is shown in the tray icon hint popup and context menu and is used as the server form title.

property ServerName: String read write;

String ServerName { get; set; }

Property ServerName() As String

ShowBalloonFlagRegistryKey

Gets or sets the registry key name where the flag indicates whether the server name should be shown in a balloon when the server's main form is minimized to tray.

This flag value is saved as an Integer value named ShowBalloonTip.

property ShowBalloonFlagRegistryKey: String read write;

String ShowBalloonFlagRegistryKey { get; set; }

Property ShowBalloonFlagRegistryKey() As String

ShowBalloonTip

Gets or sets a flag indicating whether the server name should be shown in a balloon when the server's main form is minimized to tray.

property ShowBalloonTip: Boolean read write;

Boolean ShowBalloonTip { get; set; }

Property ShowBalloonTip() As Boolean

ShutdownServer protected

Shuts the server down.

This method should be overridden to provide proper cleanup procedures (like closing all network connections etc.).

method ShutdownServer

void ShutdownServer()

Sub ShutdownServer()

StartServer protected

Starts the server.

This method should be overridden to provide proper server startup procedures (like creating network communication components etc.).

method StartServer

void StartServer()

Sub StartServer()

StopServer protected

Stops the server.

This method should be overridden to provide proper server stop procedures (like closing network and database connections etc.).

Note that the server might be stopped but not shut down, so this method is not equal to the ShutdownServer method.

method StopServer

void StopServer()

Sub StopServer()

TrayIcon

Gets or sets the icon image that will be shown in the tray.

property TrayIcon: Icon read write;

Icon TrayIcon { get; set; }

Property TrayIcon() As Icon