SysLog Class

Properties Methods Events Configuration Settings Errors

The Syslog class is used to send and receive network system log packets.

Syntax

SysLog

Remarks

The Syslog class implements a lightweight BSD syslog client as specified in RFC 3164 (UDP), RFC 5425 (SSL/TLS), and RFC 6587 (TCP). The class is used to send and receive BSD system network logging packets.

The first step in using the Syslog class is to set LocalHost and LocalPort to the interface and port on which the host will be receiving syslog packets, then set Active to True. For each packet, the class will parse the headers and message and fire a PacketIn event.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.


Active	Indicates whether the class is active.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPort	The port in the local host where Syslog binds.
RemoteHost	Sets a specific host for outgoing log packets.
RemotePort	Sets a specific port for outgoing log packets.
SSLAcceptServerCertEncoded	This is the certificate (PEM/base64 encoded).
SSLAuthenticateClients	If true, the server asks the client(s) for a certificate.
SSLCertEncoded	This is the certificate (PEM/base64 encoded).
SSLCertStore	This is the name of the certificate store for the client certificate.
SSLCertStorePassword	If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreType	This is the type of certificate store for this certificate.
SSLCertSubject	This is the subject of the certificate used for client authentication.
SSLEnabled	Whether TLS/SSL is enabled.
SSLServerCertEncoded	This is the certificate (PEM/base64 encoded).
UseTCP	Whether to use TCP.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.


Activate	Enables sending and receiving of data.
Config	Sets or retrieves a configuration setting.
Deactivate	Disables sending and receive of data.
DoEvents	Processes events from the internal message queue.
Reset	Reset the class.
ResolveRemoteHost	Resolves the hostname in RemoteHost to an IP address.
SendPacket	Send a log packet to RemoteHost .

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.


Connected	Fired immediately after a connection completes (or fails).
ConnectionStatus	TBD.
Disconnected	TBD.
Error	Information about errors during data delivery.
PacketIn	Fires whenever a system log packet is received.
SSLClientAuthentication	Fired when the client presents its credentials to the server.
SSLServerAuthentication	Fires when connecting to the server.
SSLStatus	Shows the progress of the secure connection.

Configuration Settings

The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.


AcceptData	Whether the class can accept/receive data.
AppName	Sets the App-Name field in RFC 5424.
DelayHostResolution	Whether the hostname is resolved when RemoteHost is set.
MsgId	Sets the MsgId field in RFC 5424.
ProcId	Sets the ProcId field in RFC 5424.
ReceivedAppName	Returns the value of the App-Name field in RFC 5424.
ReceivedMsgId	Returns the value of the MsgId field in RFC 5424.
ReceivedProcId	Returns the value of the ProcId field in RFC 5424.
ReceivedSDElementCount	Returns the number of Structured-data elements in RFC 5424.
ReceivedSDElementId	Returns the Sd-Id value of the Sd-element with the specified SDElementIndex in RFC 5424.
ReceivedSDElementIndex	Returns the index of the Structured-Data element in RFC 5424.
ReceivedSDParamCount	Returns the number of the Sd-param values for the specified SDElementIndex in RFC 5424.
ReceivedSDParamName	Returns the name of the SD-Param field in RFC 5424.
ReceivedSDParamValue	Returns the value of the SD-Param field in RFC 5424.
SDElementCount	Sets the number of Structured-data elements in RFC 5424.
SDElementId	Sets the Sd-Id value of the Sd-element with the specified SDElementIndex in RFC 5424.
SDElementIndex	Sets the index of the Structured-Data element in RFC 5424.
SDParamCount	Sets the number of the Sd-param values for the specified SDElementIndex in RFC 5424.
SDParamName	Sets the name of the SD-Param field in RFC 5424.
SDParamValue	Sets the value of the SD-Param field in RFC 5424.
TCPMessageDelimiter	The message delimiter to use (if any) when sending and receiving over TCP.
UseHostname	Determines if the local host name or IP address is used in the Syslog header.
UseLocalTime	Indicates whether to use local time or GMT time for packet timestamps.
Version	Determines which Syslog version to use.
CaptureIPPacketInfo	Used to capture the packet information.
DelayHostResolution	Whether the hostname is resolved when RemoteHost is set.
DestinationAddress	Used to get the destination address from the packet information.
DontFragment	Used to set the Don't Fragment flag of outgoing packets.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The port in the local host where the class binds.
MaxPacketSize	The maximum length of the packets that can be received.
QOSDSCPValue	Used to specify an arbitrary QOS/DSCP setting (optional).
QOSTrafficType	Used to specify QOS/DSCP settings (optional).
ShareLocalPort	If set to True, allows more than one instance of the class to be active on the same local port.
UseConnection	Determines whether to use a connected socket.
UseIPv6	Whether or not to use IPv6.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
UseInternalSecurityAPI	Tells the class whether or not to use the system security libraries or an internal implementation.

Active Property (SysLog Class)

Indicates whether the class is active.

Syntax

bool GetActive();
int SetActive(bool bActive);

Default Value

false

Remarks

This property indicates whether the class is currently active and can send or receive data.

Note: Use the Activate or Deactivate method to control whether the class is active.

This property is not available at design time.

Data Type

Boolean

LocalHost Property (SysLog Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

Default Value

Remarks

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

LocalPort Property (SysLog Class)

The port in the local host where Syslog binds.

Syntax

int GetLocalPort();
int SetLocalPort(int iLocalPort);

Default Value

514

Remarks

The LocalPort property must be set before Syslog is activated (Active is set to True). It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting it to 0 (default) enables the TCP/IP stack to choose a port at random. The chosen port will be shown by the LocalPort property after the connection is established.

LocalPort cannot be changed once the class is Active. Any attempt to set the LocalPort property when the class is Active will generate an error.

The LocalPort property is useful when trying to connect to services that require a trusted port in the client side.

Data Type

Integer

RemoteHost Property (SysLog Class)

Sets a specific host for outgoing log packets.

Syntax

QString GetRemoteHost();
int SetRemoteHost(QString qsRemoteHost);

Default Value

"255.255.255.255"

Remarks

When a call is made to the SendPacket method, the class will send it to whatever value is in RemoteHost. The default value is the broadcast address, "255.255.255.255".

Data Type

String

RemotePort Property (SysLog Class)

Sets a specific port for outgoing log packets.

Syntax

int GetRemotePort();
int SetRemotePort(int iRemotePort);

Default Value

514

Remarks

When a call is made to the SendPacket method, the class will send to RemoteHost on RemotePort. The default value is 514, the standard port as defined in the BSD syslog RFC 3164.

Data Type

Integer

SSLAcceptServerCertEncoded Property (SysLog Class)

This is the certificate (PEM/base64 encoded).

Syntax

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Default Value

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Byte Array

SSLAuthenticateClients Property (SysLog Class)

If true, the server asks the client(s) for a certificate.

Syntax

bool GetSSLAuthenticateClients();
int SetSSLAuthenticateClients(bool bSSLAuthenticateClients);

Default Value

false

Remarks

This property is used in conjunction with the SSLClientAuthentication event. Please refer to the documentation of the SSLClientAuthentication event for details.

Data Type

Boolean

SSLCertEncoded Property (SysLog Class)

This is the certificate (PEM/base64 encoded).

Syntax

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Default Value

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Byte Array

SSLCertStore Property (SysLog Class)

This is the name of the certificate store for the client certificate.

Syntax

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

Data Type

Byte Array

SSLCertStorePassword Property (SysLog Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

Default Value

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (SysLog Class)

This is the type of certificate store for this certificate.

Syntax

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Possible Values

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_AUTO(99)

Default Value

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
20 (cstSecurityKey)	The certificate is present on a physical security key accessible via a PKCS11 interface. To use a security key the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to `cstSecurityKey`, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN. Code Example: SSH Authentication with Security Key `certmgr.CertStoreType = CertStoreTypes.cstSecurityKey; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstSecurityKey, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET.
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Data Type

Integer

SSLCertSubject Property (SysLog Class)

This is the subject of the certificate used for client authentication.

Syntax

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

Default Value

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.


Field	Meaning
CN	Common Name. This is commonly a host name like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

If a field value contains a comma it must be quoted.

Data Type

String

SSLEnabled Property (SysLog Class)

Whether TLS/SSL is enabled.

Syntax

bool GetSSLEnabled();
int SetSSLEnabled(bool bSSLEnabled);

Default Value

false

Remarks

This setting specifies whether TLS/SSL is enabled in the class. When False (default) the class operates in plaintext mode. When True TLS/SSL is enabled.

Note: TLS/SSL can only be used when UseTCP is true.

This property is not available at design time.

Data Type

Boolean

SSLServerCertEncoded Property (SysLog Class)

This is the certificate (PEM/base64 encoded).

Syntax

QByteArray GetSSLServerCertEncoded();

Default Value

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

This property is read-only and not available at design time.

Data Type

Byte Array

UseTCP Property (SysLog Class)

Whether to use TCP.

Syntax

bool GetUseTCP();
int SetUseTCP(bool bUseTCP);

Default Value

false

Remarks

This property specifies whether TCP is used. By default this proprety is False and UDP is used. When set to True TCP will be used as the underlying protocol.

When set to True the following additional settings are also applicable:

SSLAuthenticateClients
SSLEnabled
SSLAcceptServerCert*
SSLCert*
SSLServerCert*
TCPMessageDelimiter

Data Type

Boolean

Activate Method (SysLog Class)

Enables sending and receiving of data.

Syntax

int Activate();

Remarks

This method enables sending and receiving of data. When called the class will create a communication endpoint (socket) which can be used for sending and receiving UDP messages. This method must be called before using the class to send and receive data.

If the UseConnection configuration setting is set to true, then a local association (connection) to the remote host is also created.

Error Handling

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (SysLog Class)

Sets or retrieves a configuration setting.

Syntax

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Deactivate Method (SysLog Class)

Disables sending and receive of data.

Syntax

int Deactivate();

Remarks

This method disables sending and receiving of data. When called the class will destroy the existing socket and disable data communications.

Error Handling

DoEvents Method (SysLog Class)

Processes events from the internal message queue.

Syntax

int DoEvents();

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Error Handling

Reset Method (SysLog Class)

Reset the class.

Syntax

int Reset();

Remarks

This method will reset the class's properties to their default values.

Error Handling

ResolveRemoteHost Method (SysLog Class)

Resolves the hostname in RemoteHost to an IP address.

Syntax

int ResolveRemoteHost();

Remarks

This method resolves the hostname specified by RemoteHost to an IP address. The resolved value is available in the RemoteHost property after this method returns.

In most cases calling this method is not necessary, the class will resolve the hostname automatically when necessary. If DelayHostResolution is true this method may be called to manually resolve RemoteHost if desired.

Error Handling

SendPacket Method (SysLog Class)

Send a log packet to RemoteHost .

Syntax

int SendPacket(int iFacility, int iSeverity, const QString& qsMessage);

Remarks

System log packets are composed of three main sections, each of which can be broken down into two smaller pieces.

The first section is the PRI, which contains the originating Facility and Severity of the Message. Facility is a value from 0 to 23, with each value being a different part of the system:


0	Kernel messages
1	User-level messages
2	Mail system
3	System daemons
4	Security/authorization messages
5	Messages generated internally by syslogd
6	Line printer subsystem
7	Network news subsystem
8	UUCP subsystem
9	Clock daemon
10	Security/authorization messages
11	FTP daemon
12	NTP subsystem
13	Log audit
14	Log alert
15	Clock daemon
16	Local use
17	Local use
18	Local use
19	Local use
20	Local use
21	Local use
22	Local use
23	Local use

Severity is a value from 0 to 7 using the following convention:


0	Emergency - the system is unusable
1	Alert - action must be taken immediately
2	Critical - critical conditions exist
3	Error - error conditions exist
4	Warning - warning conditions exist
5	Notice - normal but significant condition
6	Informational - informative message
7	Debug - debug-level messages

The section sections contains a timestamp and hostname, both of which are automatically generated by the class. The third section is the Message itself.

Error Handling

Connected Event (SysLog Class)

Fired immediately after a connection completes (or fails).

Syntax

class SysLogConnectedEventParams {
public:
  const QString &RemoteAddress();

  int RemotePort();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Connected(SysLogConnectedEventParams *e);

// Or, subclass SysLog and override this emitter function.
virtual int FireConnected(SysLogConnectedEventParams *e) {...}

Remarks

This event fires after a connection completes or fails.

StatusCode is the value returned by the system TCP/IP stack. This will be 0 if the connection was successful.

Description contains a human readable description of the status. This will be "OK" if the connectino was successful.

RemoteAddress is the IP address of the remote host.

RemotePort is the port on the remote host.

ConnectionStatus Event (SysLog Class)

TBD.

Syntax

class SysLogConnectionStatusEventParams {
public:
  const QString &ConnectionEvent();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ConnectionStatus(SysLogConnectionStatusEventParams *e);

// Or, subclass SysLog and override this emitter function.
virtual int FireConnectionStatus(SysLogConnectionStatusEventParams *e) {...}

Remarks

TBD.

Disconnected Event (SysLog Class)

TBD.

Syntax

class SysLogDisconnectedEventParams {
public:
  const QString &RemoteAddress();

  int RemotePort();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Disconnected(SysLogDisconnectedEventParams *e);

// Or, subclass SysLog and override this emitter function.
virtual int FireDisconnected(SysLogDisconnectedEventParams *e) {...}

Remarks

TBD.

Error Event (SysLog Class)

Information about errors during data delivery.

Syntax

class SysLogErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(SysLogErrorEventParams *e);

// Or, subclass SysLog and override this emitter function.
virtual int FireError(SysLogErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

PacketIn Event (SysLog Class)

Fires whenever a system log packet is received.

Syntax

class SysLogPacketInEventParams {
public:
  int FacilityCode();

  const QString &Facility();

  int SeverityCode();

  const QString &Severity();

  const QString &Timestamp();

  const QString &Hostname();

  const QString &Message();

  bool Conforms();

  const QByteArray &Packet();

  const QString &SourceAddress();

  int SourcePort();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void PacketIn(SysLogPacketInEventParams *e);

// Or, subclass SysLog and override this emitter function.
virtual int FirePacketIn(SysLogPacketInEventParams *e) {...}

Remarks

System log packets are composed of three main sections, each of which can be broken down into two smaller pieces.

The first section is the PRI, which contains the originating FacilityCode and SeverityCode of the Message. FacilityCode is a value from 0 to 23, with each value being a different part of the system. Facility is a string representation of FacilityCode based on the following convention:


0	Kernel messages
1	User-level messages
2	Mail system
3	System daemons
4	Security/authorization messages
5	Messages generated internally by syslogd
6	Line printer subsystem
7	Network news subsystem
8	UUCP subsystem
9	Clock daemon
10	Security/authorization messages
11	FTP daemon
12	NTP subsystem
13	Log audit
14	Log alert
15	Clock daemon
16	Local use
17	Local use
18	Local use
19	Local use
20	Local use
21	Local use
22	Local use
23	Local use

SeverityCode is a value from 0 to 7. Severity is a string representation of SeverityCode using the following convention:


0	Emergency - the system is unusable.
1	Alert - action must be taken immediately.
2	Critical - critical conditions exist.
3	Error - error conditions exist.
4	Warning - warning conditions exist.
5	Notice - normal but significant condition.
6	Informational - informative message.
7	Debug - debug-level messages.

The second section contains the Timestamp and Hostname. Timestamp is a string that should conform to the standard structure "MMM DD, HH:MM:SS". The class will search for the Timestamp and verify that it conforms. If it conforms, the class will set Hostname, otherwise, everything after the PRI will be placed in Message.

If Conforms is TRUE, then the original syslog packet conforms to the syslog RFC and Timestamp, Hostname, and Message will all have valid values. Otherwise, you should parse the contents of Packet to verify the fields manually.

SourceAddress and SourcePort are the address and port from which Packet was sent. This can be an intermediate syslog server that is simply forwarding packets from the original host.

SSLClientAuthentication Event (SysLog Class)

Fired when the client presents its credentials to the server.

Syntax

class SysLogSSLClientAuthenticationEventParams {
public:
  const QString &RemoteAddress();

  int RemotePort();

  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLClientAuthentication(SysLogSSLClientAuthenticationEventParams *e);

// Or, subclass SysLog and override this emitter function.
virtual int FireSSLClientAuthentication(SysLogSSLClientAuthenticationEventParams *e) {...}

Remarks

This event fires when a client connects to the class and presents a certificate for authentication. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK").

RemoteAddress is the IP address of the connecting client.

RemotePort is the source port of the connecting client.

CertEncoded is the base64 encoded certificate presented by the client.

CertSubject is the subject of the certificate presented by the client.

CertIssuer is the subject of the issuer of the certificate presented by the client.

Status is the stauts of the certificate.

Accept defines whether the certificate is accepted.

SSLServerAuthentication Event (SysLog Class)

Fires when connecting to the server.

Syntax

class SysLogSSLServerAuthenticationEventParams {
public:
  const QString &RemoteAddress();

  int RemotePort();

  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(SysLogSSLServerAuthenticationEventParams *e);

// Or, subclass SysLog and override this emitter function.
virtual int FireSSLServerAuthentication(SysLogSSLServerAuthenticationEventParams *e) {...}

Remarks

This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

RemoteAddress is the IP address of the server.

RemotePort is the source port of the server.

CertEncoded is the base64 encoded certificate presented by the server.

CertSubject is the subject of the certificate presented by the server.

CertIssuer is the subject of the issuer of the certificate presented by the server.

Status is the stauts of the certificate.

Accept defines whether the certificate is accepted.

SSLStatus Event (SysLog Class)

Shows the progress of the secure connection.

Syntax

class SysLogSSLStatusEventParams {
public:
  const QString &RemoteAddress();

  int RemotePort();

  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(SysLogSSLStatusEventParams *e);

// Or, subclass SysLog and override this emitter function.
virtual int FireSSLStatus(SysLogSSLStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. It is used to track the progress of the connection.

RemoteAddress is the IP address of the remote machine.

RemotePort is the port of the remote machine.

Message is the log message.

Configuration Settings (SysLog Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

Syslog Configuration Settings

AcceptData: Whether the component can accept/receive data.

When set to false the class will no longer be able to accept any data. The PacketIn event will not fire.

The default is true.

AppName: Sets the App-Name field in RFC 5424.

This setting specifies the App-Name field of the message as defined in RFC 5424