[Overview][Resource strings][Constants][Types][Classes][Variables][Index] Reference for unit 'simpleipc' (#fcl)

TSimpleIPCServer

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

Simple IPC server component

Declaration

Source position: simpleipc.pp line 84

type TSimpleIPCServer = class(TSimpleIPC)

protected

  FIPCComm: TIPCServerComm;

  function CommClass; virtual;

  procedure Activate; override;

  procedure Deactivate; override;

  procedure ReadMessage;

public

  constructor Create(); override;

  

Create a new instance of TSimpleIPCServer

  destructor Destroy; override;

  

Remove the TSimpleIPCServer instance from memory

  procedure StartServer;

  

Start the server

  procedure StopServer;

  

Stop the server

  function PeekMessage();

  

Check if a client message is available.

  property StringMessage: String; [r]

  

Last message as a string.

  procedure GetMessageData();

  

Read the data of the last message in a stream

  property MsgType: TMessageType; [r]

  

Last message type

  property MsgData: TStream; [r]

  

Last message data

  property InstanceID: String; [r]

  

Instance ID

published

  property Global: Boolean; [rw]

  

Is the server reachable to all users or not

  property OnMessage: TNotifyEvent; [rw]

  

Event triggered when a pessage arrives

end;

Inheritance

TSimpleIPCServer

  

Simple IPC server component

|

TSimpleIPC

  

Ancestor for client/server simple IPC classes

|

TComponent,IUnknown,IInterfaceComponentReference

|

TPersistent

|

TObject

Description

TSimpleIPCServer is the server side of the simple IPC communication protocol. The server program should create a TSimpleIPCServer instance, set its ServerID property to a unique name for the system, and then set the Active property to True (or call StartServer).

After the server was started, it can check for availability of messages with the PeekMessage call, and read the message with ReadMessage.

See also

TSimpleIPCClient

  

Simple IPC client component

TSimpleIPC

  

Ancestor for client/server simple IPC classes

TIPCServerComm

  

Internal message communication component

The latest version of this document can be found at lazarus-ccr.sourceforge.net.