Indy 9 | Content | Index | Reference

TIdSyslogServer
Hierarchy, Properties, Methods, Events, See Also, Unit: IdSyslogServer
Implements a BSD Syslog protocol as a server.

    TIdSyslogServer = class(TIdUDPServer)

Unit
IdSyslogServer
Description
TIdSyslogServer implements a server for the BSD Syslog protocol, as specified in the Internet Standards document:

- RFC 3164 - The BSD syslog Protocol (http://www.rfc-editor.prg/rfc/rfc3164.txt)

TIdSyslogServer is used to gather event notification messages from networked devices. Notification messages are represented by TIdSysLogMessage instances, and can contain information that categorize and differentiate diverse messages from processes running on the networked devices.

TIdSyslogServer can used as the termination point for notification messages, or used as a relay agent for another syslog daemon. TIdSyslogServer does not make any assumptions about the format or content of message values, and is used as a transport facility.

Use the OnSysLog event handler to implement data collection for messages in a TIdSysLogMessage instance.

TIdSyslogServer.DefaultPort
TIdSyslogServer
Port number used to listen for client transmissions.

    property DefaultPort: integer;

Description
DefaultPort is an Integer property that represents the port number used to listen for client data packets using the Syslog protocol. DefaultPort is accessed when a socket descriptor is bound for accepting incoming data packets. The value IdPORT_syslog is assigned to DefaultPort in the Create constructor.

TIdSyslogServer.Create
TIdSyslogServer, See Also
Constructor for the object instance.

    constructor Create(AOwner: TComponent); override;

Description
Create is the constructor for the object instance. Create calls the inherited Create method using AOwner as the owner for the component. Create assigns IdPORT_syslog as the value for the DefaultPort property.

TIdSyslogServer.OnSyslog
TIdSyslogServer, See Also
This event is triggered when the TIdSysLogServer receives SysLog data for collection.

    property OnSyslog: TOnSyslogEvent;

Parameters
ABinding
The binding for the peer connection.
ASysLogMessage
The TIdSysLogMessage for the message that was received. This will be destroyed by the server.
Sender
The component that triggered the event.
Description
This event is triggered when the TIdSysLogServer receives SysLog data for collection.

Created with Doc-O-Matic 2 donated to Project JEDI. Commercial license available from the Doc-O-Matic site.