TSimpleIPCServer class

In unit SimpleIPC

Simple IPC server component.

Declaration

pascal

TSimpleIPCServer = class(TSimpleIPC)

Inheritance

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.

Properties

`Queue`	protected
`Thread`	protected
`StringMessage`	public	Last message as a string.
`Message`	public	Last read message.
`MsgType`	public	Last message type.
`MsgData`	public	Last message data.
`InstanceID`	public	Instance ID.
`ThreadExecuting`	public	Is the message thread currently executing ?
`ThreadError`	public	Last thread error.
`Global`	published	Is the server reachable to all users or not.
`MaxQueue`	published	Maximum number of messages in the queue, 0 for unlimited.
`MaxAction`	published	Action to take when the number of messages will exceed MaxQueue.
`Threaded`	published	Is the server running threaded or not ?
`ThreadTimeout`	published	Timeout waiting for message.
`SynchronizeEvents`	published	Should events be run in the main thread ?

Methods

`CommClass`	protected
`PushMessage`	protected
`PopMessage`	protected
`StartComm`	protected
`StopComm`	protected
`StartThread`	protected
`StopThread`	protected
`Activate`	protected
`Deactivate`	protected
`ProcessMessage`	protected
`Create`	public	Create a new instance of TSimpleIPCServer.
`Destroy`	public	Remove the TSimpleIPCServer instance from memory.
`StartServer`	public	Start the server.
`StopServer`	public	Stop the server.
`PeekMessage`	public	Check if a client message is available.
`ReadMessage`	public	Read message from the queue.
`GetMessageData`	public	Read the data of the last message in a stream.

Events

`OnMessage`	published	Event triggered when a message arrives.
`OnMessageQueued`	published	Event called when a new message has arrived.
`OnMessageError`	published	Event called when a new message has arrived, and the queue is full.
`OnThreadError`	published	Triggered when a thread reports an error.