Unit 'singleinstance' Package
[Overview][Types][Classes][Variables][Index] [#fcl]

TBaseSingleInstance

[Properties (by Name)] [Methods (by Name)] [Events (by Name)]

Abstract class for single application instance.

Declaration

Source position: singleinstance.pp line 33

type TBaseSingleInstance = class(TComponent)

public

  constructor Create(); override;

  

Create a new instance of the TBaseSingleInstance class.

  destructor Destroy; override;

  

Stop waiting and destroy the instance.

  function Start; virtual; abstract;

  

Check if another instance of the application is running.

  procedure Stop; virtual; abstract;

  

Stop the current instance.

  procedure ServerCheckMessages; virtual; abstract;

  

Check for messages from a client application.

  procedure ClientPostParams; virtual; abstract;

  

Send parameters to the server.

  property TimeOutMessages: Integer; [rw]

  

Timeout when waiting for messages.

  property TimeOutWaitForInstances: Integer; [rw]

  

Timeout when trying to contact server instance.

  property OnServerReceivedParams: TSingleInstanceParamsEvent; [rw]

  

Event triggered during ServerCheckMessages.

  property StartResult: TSingleInstanceStart; [r]

  

Contains the result of the last Start call.

  property IsServer: Boolean; [r]

  

Is this application the server instance ?

  property IsClient: Boolean; [r]

  

Is this application the client instance ?

end;

Inheritance

TBaseSingleInstance

  

Abstract class for single application instance.

|

TComponent

|

TPersistent,IUnknown,IInterfaceComponentReference

|

TObject,IFPObserved

Description

TBaseSingleInstance is the abstract parent for classes that allow you to control the instances if your application. You must never instantiate TBaseSingleInstance directly, instead, use for example the TAdvancedSingleInstance class.

Errors

Instantiating and using this class will result in abstract errors.

See also

TAdvancedSingleInstance

  

Single Application instance class using file communication.

advancedsingleinstance

  

Implement SingleInstance using files.


Documentation generated on: Jul 24 2023