TIdSysLogMessage encapsulates a Syslog (RFC 3164) message.

TIdSysLogMessage = class(TIdBaseComponent)

TIdSysLogMessage encapsulates a Syslog (RFC 3164) message for the TIdSysLog and TIdSysLogServer components including the ability to encode and decode the SysLog message.

This property indicates the general area where the SysLog message was generated from.

property Facility: TidSyslogFacility;

This property indicates the general area where the SysLog message was generated from. Setting this property will update the TIdSysLogMessage.Pri property as appropriate.

IP address or host name for the computer sending the message.

property Hostname: string;

Hostname is a string property that represents the IP address or host name for the computer sending the message. By default, this is set the IP address of the user's computer and is obtained by using GStack.LocalAddress.

Note: This property is not stored in the DFM because the HostName property is specific to a user's computers and storing it in the form files could create a wrong value in the System log.

This property contains the text and process information of the TIdSysLogMessage.

property Msg: TIdSysLogMsgPart;

This property contains the text and process information of the TIdSysLogMessage which can be set or processed as desired. The following values are often used in the TIdSysLogMsgPart object; TIdSysLogMsgPart.PID, TIdSysLogMsgPart.Content, TIdSysLogMsgPart.Process, TIdSysLogMsgPart.PIDAvailable , TIdSysLogMsgPart.Text.

This is the peer that sent the TIdSysLogMessage.

property Peer: String;

Peer is a String property that represents the IP address or hostname for the peer that sent the TIdSysLogMessage to the TIdSysLogServer.

Pri is a calculation of the TIdSysLogMessage.Severity and TIdSysLogMessage.Facility properties and is used in transmitting the TIdSysLogMessage.

property Pri: TIdSyslogPRI;

Pri is a calculation of the TIdSysLogMessage.Severity and TIdSysLogMessage.Facility properties and is used in transmitting the TIdSysLogMessage. Setting this value to a value from 0 to 191 will update the TIdSysLogMessage.Severity and TIdSysLogMessage.Facility properties.

Raw contents of the message as read from the socket connection.

property RawMessage: string;

RawMessage is a String property that represents the raw contents of the Syslog message as read from the socket connection. RawMessage contains the values parsed to determine the contents of the Hostname, TimeStamp, Facility, Severity, Pri, and Msg properties.

This property indicates the severity of the SysLog message.

property Severity: TIdSyslogSeverity;

This property indicates the severity of the SysLog message. Setting this property will update the TIdSysLogMessage.Pri property as appropriate.

Date and time that the message was sent.

property TimeStamp: TDateTime;

TimeStamp is a TDateTime property that represents the date and time that a Syslog message was sent. TimeStamp is the value read from the header portion of the Syslog message. If an exception occurs while parsing the message header, TimeStamp will contain the current date and time.

Copies property values from a persistent source.

procedure assign(Source: TPersistent); override;

Assign is a procedure that allows property values for the current object instance to be copied from the persistent component specified in Source. When Source is an instance of TIdSysLogMessage, the values for the Pri, Msg, HostName and Timestamp properties are updated from the values in Source. Otherwise, the inherited Assign method is called.

Constructor for the object instance.

constructor Create(AOwner: TComponent); override;

Owner of the object instance.

Create is the constructor for the object instance. Create calls the inherited Create method using AOwner as the owner of the component instance. Create sets the default value for the PRI property to 13, and uses the global TIdStack instance in GStack to retrieve the value for the HostName property. Create also allocates the TIdSysLogMsgPart used to represent the Msg property.

Frees the object instance.

destructor Destroy; override;

Destroy is the destructor for the object instance. Destroy frees resources allocated in Create for the Msg property prior to calling the inherited Destroy method.

EncodeMessage encodes the SysLog message into a form for sending with a TIdSysLog component.

function EncodeMessage: String; virtual;

EncodeMessage encodes the SysLog message into a form for sending with a TIdSysLog component.

This message reads a SysLog message from stream.

procedure ReadFromStream(Src: TStream; Size: integer; APeer: String); virtual;

The stream to read the SysLog message from

The size of the data to read

The sender's address

This message reads a SysLog message from stream and sets the TIdSysLogMessage as required. This method is usually called by the TIdSysLogServer before calling the TIdSysLogServer.OnSyslog event handler.

Sends the Syslog message to the host specified host.

procedure SendToHost(const Dest: String);

Host name or IP address to receive the syslog message.

SendToHost is public procedure used to send the Syslog message to the host name or IP address indicated in Dest. SendToHost will create a temporary TIdUDPClient instance, when one has nopt already been assigned, to be used to for the transmission to the Syslog daemon in Dest. SendtoHost call TIdUDPClient.Send using Dest and IdPORT_syslog as the destintination for the contents of the message created using EncodeMessage.