SysLog Class

Properties   Methods   Events   Config 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 (User Datagram Protocol [UDP]), RFC 5425 (Secure Sockets Layer/Transport Layer Security [SSL/TLS]), and RFC 6587 (Transmission Control Protocol [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, and then call the Activate method. 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.

Method List

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

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.

Config Settings

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

Active Property (SysLog Class)

This property indicates whether the class is active.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetActive();

Unicode (Windows)
BOOL GetActive();

int ipworks_syslog_getactive(void* lpObj);

bool GetActive();

Default Value

FALSE

Remarks

This property indicates whether the class is currently active and can send or receive data. Use the Activate and Deactivate methods to control whether the class is active.

This property is read-only and 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

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* ipworks_syslog_getlocalhost(void* lpObj);
int ipworks_syslog_setlocalhost(void* lpObj, const char* lpszLocalHost);

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

Default Value

""

Remarks

This 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 multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

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 multihomed 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)

This property indicates the port in the local host where Syslog binds.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLocalPort();
int SetLocalPort(int iLocalPort);

Unicode (Windows)
INT GetLocalPort();
INT SetLocalPort(INT iLocalPort);

int ipworks_syslog_getlocalport(void* lpObj);
int ipworks_syslog_setlocalport(void* lpObj, int iLocalPort);

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

Default Value

514

Remarks

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

Setting it to 0 enables the Transmission Control Protocol (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)

This property sets a specific host for outgoing log packets.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRemoteHost();
int SetRemoteHost(const char* lpszRemoteHost);

Unicode (Windows)
LPWSTR GetRemoteHost();
INT SetRemoteHost(LPCWSTR lpszRemoteHost);

char* ipworks_syslog_getremotehost(void* lpObj);
int ipworks_syslog_setremotehost(void* lpObj, const char* lpszRemoteHost);

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)

This property sets a specific port for outgoing log packets.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRemotePort();
int SetRemotePort(int iRemotePort);

Unicode (Windows)
INT GetRemotePort();
INT SetRemotePort(INT iRemotePort);

int ipworks_syslog_getremoteport(void* lpObj);
int ipworks_syslog_setremoteport(void* lpObj, int iRemotePort);

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

SSLAcceptServerCert Property (SysLog Class)

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C++
• C
• Qt

IPWorksCertificate* GetSSLAcceptServerCert();
int SetSSLAcceptServerCert(IPWorksCertificate* val);

char* ipworks_syslog_getsslacceptservercerteffectivedate(void* lpObj);

char* ipworks_syslog_getsslacceptservercertexpirationdate(void* lpObj);

char* ipworks_syslog_getsslacceptservercertextendedkeyusage(void* lpObj);

char* ipworks_syslog_getsslacceptservercertfingerprint(void* lpObj);

char* ipworks_syslog_getsslacceptservercertfingerprintsha1(void* lpObj);

char* ipworks_syslog_getsslacceptservercertfingerprintsha256(void* lpObj);

char* ipworks_syslog_getsslacceptservercertissuer(void* lpObj);

char* ipworks_syslog_getsslacceptservercertprivatekey(void* lpObj);

int ipworks_syslog_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* ipworks_syslog_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* ipworks_syslog_getsslacceptservercertpublickey(void* lpObj);

char* ipworks_syslog_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int ipworks_syslog_getsslacceptservercertpublickeylength(void* lpObj);

char* ipworks_syslog_getsslacceptservercertserialnumber(void* lpObj);

char* ipworks_syslog_getsslacceptservercertsignaturealgorithm(void* lpObj);

int ipworks_syslog_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int ipworks_syslog_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* ipworks_syslog_getsslacceptservercertstorepassword(void* lpObj);
int ipworks_syslog_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int ipworks_syslog_getsslacceptservercertstoretype(void* lpObj);
int ipworks_syslog_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* ipworks_syslog_getsslacceptservercertsubjectaltnames(void* lpObj);

char* ipworks_syslog_getsslacceptservercertthumbprintmd5(void* lpObj);

char* ipworks_syslog_getsslacceptservercertthumbprintsha1(void* lpObj);

char* ipworks_syslog_getsslacceptservercertthumbprintsha256(void* lpObj);

char* ipworks_syslog_getsslacceptservercertusage(void* lpObj);

int ipworks_syslog_getsslacceptservercertusageflags(void* lpObj);

char* ipworks_syslog_getsslacceptservercertversion(void* lpObj);

char* ipworks_syslog_getsslacceptservercertsubject(void* lpObj);
int ipworks_syslog_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int ipworks_syslog_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int ipworks_syslog_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QString GetSSLAcceptServerCertEffectiveDate();

QString GetSSLAcceptServerCertExpirationDate();

QString GetSSLAcceptServerCertExtendedKeyUsage();

QString GetSSLAcceptServerCertFingerprint();

QString GetSSLAcceptServerCertFingerprintSHA1();

QString GetSSLAcceptServerCertFingerprintSHA256();

QString GetSSLAcceptServerCertIssuer();

QString GetSSLAcceptServerCertPrivateKey();

bool GetSSLAcceptServerCertPrivateKeyAvailable();

QString GetSSLAcceptServerCertPrivateKeyContainer();

QString GetSSLAcceptServerCertPublicKey();

QString GetSSLAcceptServerCertPublicKeyAlgorithm();

int GetSSLAcceptServerCertPublicKeyLength();

QString GetSSLAcceptServerCertSerialNumber();

QString GetSSLAcceptServerCertSignatureAlgorithm();

QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore);

QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword);

int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType);

QString GetSSLAcceptServerCertSubjectAltNames();

QString GetSSLAcceptServerCertThumbprintMD5();

QString GetSSLAcceptServerCertThumbprintSHA1();

QString GetSSLAcceptServerCertThumbprintSHA256();

QString GetSSLAcceptServerCertUsage();

int GetSSLAcceptServerCertUsageFlags();

QString GetSSLAcceptServerCertVersion();

QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject);

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

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

Data Type

IPWorksCertificate

SSLAuthenticateClients Property (SysLog Class)

If set to True, the server asks the client(s) for a certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAuthenticateClients();
int SetSSLAuthenticateClients(int bSSLAuthenticateClients);

Unicode (Windows)
BOOL GetSSLAuthenticateClients();
INT SetSSLAuthenticateClients(BOOL bSSLAuthenticateClients);

int ipworks_syslog_getsslauthenticateclients(void* lpObj);
int ipworks_syslog_setsslauthenticateclients(void* lpObj, int bSSLAuthenticateClients);

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

SSLCert Property (SysLog Class)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

• C++
• C
• Qt

IPWorksCertificate* GetSSLCert();
int SetSSLCert(IPWorksCertificate* val);

char* ipworks_syslog_getsslcerteffectivedate(void* lpObj);

char* ipworks_syslog_getsslcertexpirationdate(void* lpObj);

char* ipworks_syslog_getsslcertextendedkeyusage(void* lpObj);

char* ipworks_syslog_getsslcertfingerprint(void* lpObj);

char* ipworks_syslog_getsslcertfingerprintsha1(void* lpObj);

char* ipworks_syslog_getsslcertfingerprintsha256(void* lpObj);

char* ipworks_syslog_getsslcertissuer(void* lpObj);

char* ipworks_syslog_getsslcertprivatekey(void* lpObj);

int ipworks_syslog_getsslcertprivatekeyavailable(void* lpObj);

char* ipworks_syslog_getsslcertprivatekeycontainer(void* lpObj);

char* ipworks_syslog_getsslcertpublickey(void* lpObj);

char* ipworks_syslog_getsslcertpublickeyalgorithm(void* lpObj);

int ipworks_syslog_getsslcertpublickeylength(void* lpObj);

char* ipworks_syslog_getsslcertserialnumber(void* lpObj);

char* ipworks_syslog_getsslcertsignaturealgorithm(void* lpObj);

int ipworks_syslog_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworks_syslog_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* ipworks_syslog_getsslcertstorepassword(void* lpObj);
int ipworks_syslog_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int ipworks_syslog_getsslcertstoretype(void* lpObj);
int ipworks_syslog_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* ipworks_syslog_getsslcertsubjectaltnames(void* lpObj);

char* ipworks_syslog_getsslcertthumbprintmd5(void* lpObj);

char* ipworks_syslog_getsslcertthumbprintsha1(void* lpObj);

char* ipworks_syslog_getsslcertthumbprintsha256(void* lpObj);

char* ipworks_syslog_getsslcertusage(void* lpObj);

int ipworks_syslog_getsslcertusageflags(void* lpObj);

char* ipworks_syslog_getsslcertversion(void* lpObj);

char* ipworks_syslog_getsslcertsubject(void* lpObj);
int ipworks_syslog_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int ipworks_syslog_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworks_syslog_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QString GetSSLCertEffectiveDate();

QString GetSSLCertExpirationDate();

QString GetSSLCertExtendedKeyUsage();

QString GetSSLCertFingerprint();

QString GetSSLCertFingerprintSHA1();

QString GetSSLCertFingerprintSHA256();

QString GetSSLCertIssuer();

QString GetSSLCertPrivateKey();

bool GetSSLCertPrivateKeyAvailable();

QString GetSSLCertPrivateKeyContainer();

QString GetSSLCertPublicKey();

QString GetSSLCertPublicKeyAlgorithm();

int GetSSLCertPublicKeyLength();

QString GetSSLCertSerialNumber();

QString GetSSLCertSignatureAlgorithm();

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

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

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

QString GetSSLCertSubjectAltNames();

QString GetSSLCertThumbprintMD5();

QString GetSSLCertThumbprintSHA1();

QString GetSSLCertThumbprintSHA256();

QString GetSSLCertUsage();

int GetSSLCertUsageFlags();

QString GetSSLCertVersion();

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

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

Remarks

This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Data Type

IPWorksCertificate

SSLEnabled Property (SysLog Class)

This property indicates whether Secure Sockets Layer/Transport Layer Security (TLS/SSL) is enabled.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLEnabled();
int SetSSLEnabled(int bSSLEnabled);

Unicode (Windows)
BOOL GetSSLEnabled();
INT SetSSLEnabled(BOOL bSSLEnabled);

int ipworks_syslog_getsslenabled(void* lpObj);
int ipworks_syslog_setsslenabled(void* lpObj, int bSSLEnabled);

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 be used only when UseTCP is true.

This property is not available at design time.

Data Type

Boolean

SSLServerCert Property (SysLog Class)

The server certificate for the last established connection.

Syntax

• C++
• C
• Qt

IPWorksCertificate* GetSSLServerCert();

char* ipworks_syslog_getsslservercerteffectivedate(void* lpObj);

char* ipworks_syslog_getsslservercertexpirationdate(void* lpObj);

char* ipworks_syslog_getsslservercertextendedkeyusage(void* lpObj);

char* ipworks_syslog_getsslservercertfingerprint(void* lpObj);

char* ipworks_syslog_getsslservercertfingerprintsha1(void* lpObj);

char* ipworks_syslog_getsslservercertfingerprintsha256(void* lpObj);

char* ipworks_syslog_getsslservercertissuer(void* lpObj);

char* ipworks_syslog_getsslservercertprivatekey(void* lpObj);

int ipworks_syslog_getsslservercertprivatekeyavailable(void* lpObj);

char* ipworks_syslog_getsslservercertprivatekeycontainer(void* lpObj);

char* ipworks_syslog_getsslservercertpublickey(void* lpObj);

char* ipworks_syslog_getsslservercertpublickeyalgorithm(void* lpObj);

int ipworks_syslog_getsslservercertpublickeylength(void* lpObj);

char* ipworks_syslog_getsslservercertserialnumber(void* lpObj);

char* ipworks_syslog_getsslservercertsignaturealgorithm(void* lpObj);

int ipworks_syslog_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);

char* ipworks_syslog_getsslservercertstorepassword(void* lpObj);

int ipworks_syslog_getsslservercertstoretype(void* lpObj);

char* ipworks_syslog_getsslservercertsubjectaltnames(void* lpObj);

char* ipworks_syslog_getsslservercertthumbprintmd5(void* lpObj);

char* ipworks_syslog_getsslservercertthumbprintsha1(void* lpObj);

char* ipworks_syslog_getsslservercertthumbprintsha256(void* lpObj);

char* ipworks_syslog_getsslservercertusage(void* lpObj);

int ipworks_syslog_getsslservercertusageflags(void* lpObj);

char* ipworks_syslog_getsslservercertversion(void* lpObj);

char* ipworks_syslog_getsslservercertsubject(void* lpObj);

int ipworks_syslog_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QString GetSSLServerCertEffectiveDate();

QString GetSSLServerCertExpirationDate();

QString GetSSLServerCertExtendedKeyUsage();

QString GetSSLServerCertFingerprint();

QString GetSSLServerCertFingerprintSHA1();

QString GetSSLServerCertFingerprintSHA256();

QString GetSSLServerCertIssuer();

QString GetSSLServerCertPrivateKey();

bool GetSSLServerCertPrivateKeyAvailable();

QString GetSSLServerCertPrivateKeyContainer();

QString GetSSLServerCertPublicKey();

QString GetSSLServerCertPublicKeyAlgorithm();

int GetSSLServerCertPublicKeyLength();

QString GetSSLServerCertSerialNumber();

QString GetSSLServerCertSignatureAlgorithm();

QByteArray GetSSLServerCertStore();

QString GetSSLServerCertStorePassword();

int GetSSLServerCertStoreType();

QString GetSSLServerCertSubjectAltNames();

QString GetSSLServerCertThumbprintMD5();

QString GetSSLServerCertThumbprintSHA1();

QString GetSSLServerCertThumbprintSHA256();

QString GetSSLServerCertUsage();

int GetSSLServerCertUsageFlags();

QString GetSSLServerCertVersion();

QString GetSSLServerCertSubject();

QByteArray GetSSLServerCertEncoded();

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Data Type

IPWorksCertificate

UseTCP Property (SysLog Class)

This property specifies whether Transmission Control Protocol (TCP) is used.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUseTCP();
int SetUseTCP(int bUseTCP);

Unicode (Windows)
BOOL GetUseTCP();
INT SetUseTCP(BOOL bUseTCP);

int ipworks_syslog_getusetcp(void* lpObj);
int ipworks_syslog_setusetcp(void* lpObj, int bUseTCP);

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

Default Value

FALSE

Remarks

This property specifies whether TCP is used. By default, this property 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)

This method enables sending and receiving of data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Activate();

Unicode (Windows)
INT Activate();

int ipworks_syslog_activate(void* lpObj);

int Activate();

Remarks

This method enables sending and receiving of data. When called, the class will create a communication endpoint (socket) that can be used for sending and receiving User Datagram Protocol (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 (C++)

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

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworks_syslog_config(void* lpObj, const char* lpszConfigurationString);

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 (C++)

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)

This method disables sending and receive of data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Deactivate();

Unicode (Windows)
INT Deactivate();

int ipworks_syslog_deactivate(void* lpObj);

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 (C++)

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.)

DoEvents Method (SysLog Class)

This method processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworks_syslog_doevents(void* lpObj);

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 (C++)

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.)

Reset Method (SysLog Class)

This method will reset the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworks_syslog_reset(void* lpObj);

int Reset();

Remarks

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

Error Handling (C++)

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.)

ResolveRemoteHost Method (SysLog Class)

This method resolves the hostname in RemoteHost to an IP address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ResolveRemoteHost();

Unicode (Windows)
INT ResolveRemoteHost();

int ipworks_syslog_resolveremotehost(void* lpObj);

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 needed. If DelayHostResolution is true, this method may be called to manually resolve RemoteHost, if desired.

Error Handling (C++)

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.)

SendPacket Method (SysLog Class)

This method sends a log packet to RemoteHost .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendPacket(int iFacility, int iSeverity, const char* lpszMessage);

Unicode (Windows)
INT SendPacket(INT iFacility, INT iSeverity, LPCWSTR lpszMessage);

int ipworks_syslog_sendpacket(void* lpObj, int iFacility, int iSeverity, const char* lpszMessage);

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:

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

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

Error Handling (C++)

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.)

Connected Event (SysLog Class)

This event is fired immediately after a connection completes (or fails).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnected(SysLogConnectedEventParams *e);

typedef struct {
  const char *RemoteAddress;
  int RemotePort;
  int StatusCode;
  const char *Description;
  int reserved;
} SysLogConnectedEventParams;


Unicode (Windows)
virtual INT FireConnected(SysLogConnectedEventParams *e);

typedef struct {
  LPCWSTR RemoteAddress;
  INT RemotePort;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} SysLogConnectedEventParams;

#define EID_SYSLOG_CONNECTED 1

virtual INT IPWORKS_CALL FireConnected(LPSTR &lpszRemoteAddress, INT &iRemotePort, INT &iStatusCode, LPSTR &lpszDescription);

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 Transmission Control Protocol (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 connection was successful.

RemoteAddress is the IP address of the remote host.

RemotePort is the port on the remote host.

ConnectionStatus Event (SysLog Class)

This event is fired to indicate changes in a connection state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnectionStatus(SysLogConnectionStatusEventParams *e);

typedef struct {
  const char *ConnectionEvent;
  int StatusCode;
  const char *Description;
  int reserved;
} SysLogConnectionStatusEventParams;


Unicode (Windows)
virtual INT FireConnectionStatus(SysLogConnectionStatusEventParams *e);

typedef struct {
  LPCWSTR ConnectionEvent;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} SysLogConnectionStatusEventParams;

#define EID_SYSLOG_CONNECTIONSTATUS 2

virtual INT IPWORKS_CALL FireConnectionStatus(LPSTR &lpszConnectionEvent, INT &iStatusCode, LPSTR &lpszDescription);

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

The ConnectionStatus event is fired when the connection state changes: for example, upon completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

Disconnected Event (SysLog Class)

This event is fired when a connection is closed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDisconnected(SysLogDisconnectedEventParams *e);

typedef struct {
  const char *RemoteAddress;
  int RemotePort;
  int StatusCode;
  const char *Description;
  int reserved;
} SysLogDisconnectedEventParams;


Unicode (Windows)
virtual INT FireDisconnected(SysLogDisconnectedEventParams *e);

typedef struct {
  LPCWSTR RemoteAddress;
  INT RemotePort;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} SysLogDisconnectedEventParams;

#define EID_SYSLOG_DISCONNECTED 3

virtual INT IPWORKS_CALL FireDisconnected(LPSTR &lpszRemoteAddress, INT &iRemotePort, INT &iStatusCode, LPSTR &lpszDescription);

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

This event fires when a connection is closed.

StatusCode is the value returned by the system Transmission Control Protocol (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 connection was successful.

RemoteAddress is the IP address of the remote host.

RemotePort is the port on the remote host.

Error Event (SysLog Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(SysLogErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} SysLogErrorEventParams;


Unicode (Windows)
virtual INT FireError(SysLogErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} SysLogErrorEventParams;

#define EID_SYSLOG_ERROR 4

virtual INT IPWORKS_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

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.

The ErrorCode parameter contains an error code, and the Description parameter 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)

This event fires whenever a system log packet is received.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FirePacketIn(SysLogPacketInEventParams *e);

typedef struct {
  int FacilityCode;
  const char *Facility;
  int SeverityCode;
  const char *Severity;
  const char *Timestamp;
  const char *Hostname;
  const char *Message;
  int Conforms;
  const char *Packet;
  int lenPacket;
  const char *SourceAddress;
  int SourcePort;
  int reserved;
} SysLogPacketInEventParams;


Unicode (Windows)
virtual INT FirePacketIn(SysLogPacketInEventParams *e);

typedef struct {
  INT FacilityCode;
  LPCWSTR Facility;
  INT SeverityCode;
  LPCWSTR Severity;
  LPCWSTR Timestamp;
  LPCWSTR Hostname;
  LPCWSTR Message;
  BOOL Conforms;
  LPCSTR Packet;
  INT lenPacket;
  LPCWSTR SourceAddress;
  INT SourcePort;
  INT reserved;
} SysLogPacketInEventParams;

#define EID_SYSLOG_PACKETIN 5

virtual INT IPWORKS_CALL FirePacketIn(INT &iFacilityCode, LPSTR &lpszFacility, INT &iSeverityCode, LPSTR &lpszSeverity, LPSTR &lpszTimestamp, LPSTR &lpszHostname, LPSTR &lpszMessage, BOOL &bConforms, LPSTR &lpPacket, INT &lenPacket, LPSTR &lpszSourceAddress, INT &iSourcePort);

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:

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)

This is event fired when the client presents its credentials to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLClientAuthentication(SysLogSSLClientAuthenticationEventParams *e);

typedef struct {
  const char *RemoteAddress;
  int RemotePort;
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} SysLogSSLClientAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLClientAuthentication(SysLogSSLClientAuthenticationEventParams *e);

typedef struct {
  LPCWSTR RemoteAddress;
  INT RemotePort;
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} SysLogSSLClientAuthenticationEventParams;

#define EID_SYSLOG_SSLCLIENTAUTHENTICATION 6

virtual INT IPWORKS_CALL FireSSLClientAuthentication(LPSTR &lpszRemoteAddress, INT &iRemotePort, LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

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 or not to continue.

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 status of the certificate.

Accept defines whether the certificate is accepted.

SSLServerAuthentication Event (SysLog Class)

This event fires when connecting to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(SysLogSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *RemoteAddress;
  int RemotePort;
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} SysLogSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(SysLogSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCWSTR RemoteAddress;
  INT RemotePort;
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} SysLogSSLServerAuthenticationEventParams;

#define EID_SYSLOG_SSLSERVERAUTHENTICATION 7

virtual INT IPWORKS_CALL FireSSLServerAuthentication(LPSTR &lpszRemoteAddress, INT &iRemotePort, LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

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

During this event, the client can decide whether or not to continue with the connection process. 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 or not to continue.

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 status of the certificate.

Accept defines whether the certificate is accepted.

SSLStatus Event (SysLog Class)

This event shows the progress of the secure connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(SysLogSSLStatusEventParams *e);

typedef struct {
  const char *RemoteAddress;
  int RemotePort;
  const char *Message;
  int reserved;
} SysLogSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(SysLogSSLStatusEventParams *e);

typedef struct {
  LPCWSTR RemoteAddress;
  INT RemotePort;
  LPCWSTR Message;
  INT reserved;
} SysLogSSLStatusEventParams;

#define EID_SYSLOG_SSLSTATUS 8

virtual INT IPWORKS_CALL FireSSLStatus(LPSTR &lpszRemoteAddress, INT &iRemotePort, LPSTR &lpszMessage);

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.

Certificate Type

This is the digital certificate being used.

Syntax

IPWorksCertificate (declared in ipworks.h)

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

Certificate()

Certificate(const char* lpEncoded, int lenEncoded)

Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)

Config Settings (SysLog Class)

Syslog Config Settings

UDP Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (SysLog Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

SysLog Errors

UDP Errors

SSL Errors

TCP/IP Errors