Skip to content

TIPCServerMsgQueue

A simple message queue, with FIFO characteristics and overflow management.

Declaration

Source position: simpleipc.pp line 76

type

  TIPCServerMsgQueue = class
  public
    constructor Create;
    destructor Destroy;
    procedure Clear;
    procedure Push;
    function Pop : TIPCServerMsg;
    property Count: Integer; {r}
    property MaxCount: Integer; {rw}
    property MaxAction: TIPCMessageOverflowAction; {rw}
  end;

Description

TIPCServerMsgQueue implements a message queue with FIFO characteristics. It has support for a maximum queue length (TIPCServerMsgQueue.MaxCount) and various ways of dealing with overflowing queue (TIPCServerMsgQueue.MaxAction)

Properties

Member Visibility Description
Count read only public Number of messages in the queue.
MaxAction public Action to take when the number of messages will exceed MaxCount.
MaxCount public Maximum number of messages in the queue, 0 for unlimited.

Methods

Member Visibility Description
Clear public Clear the message queue.
Create public Create a new message queue instance.
Destroy public Destroy server message queue instance.
Pop public Remove the oldest message from the queue.
Push public Add a new message to the queue.

See also

Name Description
TIPCServerMsgQueue.MaxCount Maximum number of messages in the queue, 0 for unlimited.
TIPCServerMsgQueue.MaxAction Action to take when the number of messages will exceed MaxCount.