Indy 9 | Content | Index | Reference

TIdSysLog
Hierarchy, Properties, Methods, Events, See Also, Unit: IdSysLog
TIdSysLog implements a BSD Syslog protocol client.

    TIdSysLog = class(TIdUDPClient)

Unit
IdSysLog
Description
TIdSysLog implements a BSD Syslog protocol client as specified by RFC 3164 for sending notifications to a Syslog server. The syslog protocol is designed for sending notification messages across a network. Originally, it was used by BSD Unix but has been ported to many systems and is sometimes embedded into many network devices.

TIdSysLog.Port
TIdSysLog
Port number for transmissions to the server.

    property Port: Integer;

Description
Port is an Integer property that represents the port number used for transmission of datagram packets to the logging daemon. The default value for Port is IdPORT_syslog, as assigned in the Create constructor. Port is used when creating a new socket descriptor for transmissions to the SysLog server.

TIdSysLog.Create
TIdSysLog, 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 default value for the Port property.

TIdSysLog.SendMessage
TIdSysLog, See Also
Sends a message to the loggin daemon.

    procedure SendMessage(const AMsg: TIdSysLogMessage; const AAutoTimeStamp: Boolean = true); overload;
    procedure SendMessage(const AMsg: String; const AFacility: TidSyslogFacility; const ASeverity: TIdSyslogSeverity); overload;
    procedure SendMessage(const AProcess: String; const AText: String; const AFacility: TidSyslogFacility; const ASeverity: TIdSyslogSeverity; const AUsePID: Boolean = False; const APID: Integer = -1); overload;

Parameters
const AMsg: TIdSysLogMessage
Syslog message instance or string.
const AAutoTimeStamp: Boolean = true
Add time stamp to the message.
const AFacility: TidSyslogFacility
The facility for the logged message.
const ASeverity: TIdSyslogSeverity
The severity of the logged message.
const AProcess: String
The process name.
const AText: String
Descriptive text for the syslog entry.
const AUsePID: Boolean = False
Use a process ID.
const APID: Integer = -1
Process ID for the syslog entry.
Description
SendMessage is an overloaded procedure in TIdSysLog used to form and transmit a message destined for the logging daemon.

One variant of SendMessage sends the existing TIdSyslogMessage instance identified in AMsg to the logging daemon. AAutoTimeStamp indicates if the current date and time should be applied to the TIdSyslogMessage.Timestamp property prior to transmission. This variant calls Send using the encode value for the message.

Other variants of SendMessage construct a new TIdSyslogMessage instance and populate it's values using the arguments specified for the procedure. Each of these overloaded procedure calls the SendMessage variant that uses the existing TIdSyslogMessage instance.

TIdSysLog.SendMessage
TIdSysLog, See Also
Sends a message to the loggin daemon.

    procedure SendMessage(const AMsg: TIdSysLogMessage; const AAutoTimeStamp: Boolean = true); overload;
    procedure SendMessage(const AMsg: String; const AFacility: TidSyslogFacility; const ASeverity: TIdSyslogSeverity); overload;
    procedure SendMessage(const AProcess: String; const AText: String; const AFacility: TidSyslogFacility; const ASeverity: TIdSyslogSeverity; const AUsePID: Boolean = False; const APID: Integer = -1); overload;

Parameters
const AMsg: TIdSysLogMessage
Syslog message instance or string.
const AAutoTimeStamp: Boolean = true
Add time stamp to the message.
const AFacility: TidSyslogFacility
The facility for the logged message.
const ASeverity: TIdSyslogSeverity
The severity of the logged message.
const AProcess: String
The process name.
const AText: String
Descriptive text for the syslog entry.
const AUsePID: Boolean = False
Use a process ID.
const APID: Integer = -1
Process ID for the syslog entry.
Description
SendMessage is an overloaded procedure in TIdSysLog used to form and transmit a message destined for the logging daemon.

One variant of SendMessage sends the existing TIdSyslogMessage instance identified in AMsg to the logging daemon. AAutoTimeStamp indicates if the current date and time should be applied to the TIdSyslogMessage.Timestamp property prior to transmission. This variant calls Send using the encode value for the message.

Other variants of SendMessage construct a new TIdSyslogMessage instance and populate it's values using the arguments specified for the procedure. Each of these overloaded procedure calls the SendMessage variant that uses the existing TIdSyslogMessage instance.

TIdSysLog.SendMessage
TIdSysLog, See Also
Sends a message to the loggin daemon.

    procedure SendMessage(const AMsg: TIdSysLogMessage; const AAutoTimeStamp: Boolean = true); overload;
    procedure SendMessage(const AMsg: String; const AFacility: TidSyslogFacility; const ASeverity: TIdSyslogSeverity); overload;
    procedure SendMessage(const AProcess: String; const AText: String; const AFacility: TidSyslogFacility; const ASeverity: TIdSyslogSeverity; const AUsePID: Boolean = False; const APID: Integer = -1); overload;

Parameters
const AMsg: TIdSysLogMessage
Syslog message instance or string.
const AAutoTimeStamp: Boolean = true
Add time stamp to the message.
const AFacility: TidSyslogFacility
The facility for the logged message.
const ASeverity: TIdSyslogSeverity
The severity of the logged message.
const AProcess: String
The process name.
const AText: String
Descriptive text for the syslog entry.
const AUsePID: Boolean = False
Use a process ID.
const APID: Integer = -1
Process ID for the syslog entry.
Description
SendMessage is an overloaded procedure in TIdSysLog used to form and transmit a message destined for the logging daemon.

One variant of SendMessage sends the existing TIdSyslogMessage instance identified in AMsg to the logging daemon. AAutoTimeStamp indicates if the current date and time should be applied to the TIdSyslogMessage.Timestamp property prior to transmission. This variant calls Send using the encode value for the message.

Other variants of SendMessage construct a new TIdSyslogMessage instance and populate it's values using the arguments specified for the procedure. Each of these overloaded procedure calls the SendMessage variant that uses the existing TIdSyslogMessage instance.

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