SysLog Class

Properties Methods Events Configuration Settings Errors

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

Class Name

IPWorks_SysLog

Procedural Interface

 ipworks_syslog_open();
 ipworks_syslog_close($res);
 ipworks_syslog_register_callback($res, $id, $function);
 ipworks_syslog_get_last_error($res);
 ipworks_syslog_get_last_error_code($res);
 ipworks_syslog_set($res, $id, $index, $value);
 ipworks_syslog_get($res, $id, $index);
 ipworks_syslog_do_config($res, $configurationstring);
 ipworks_syslog_do_doevents($res);
 ipworks_syslog_do_sendpacket($res, $facility, $severity, $message);

Remarks

The Syslog class implements a lightweight BSD syslog client as specified in RFC 3164. 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	Enables or disables sending and receiving of data.
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.

Method List

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


Config	Sets or retrieves a configuration setting .
DoEvents	Processes events from the internal message queue.
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.


Error	Information about errors during data delivery.
PacketIn	Fires whenever a system log packet is received.

Configuration Settings

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


UseLocalTime	Indicates whether to use local time or GMT time for packet timestamps.
UseHostname	Determines if the local host name or IP address is used in the Syslog header.
CaptureIPPacketInfo	Used to capture the packet information.
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 TCP port in the local host where the component binds.
MaxPacketSize	The maximum length of the packets that can be received.
ShareLocalPort	If set to True, allows more than one instance of the component to be active on the same local port.
UseConnection	Determines whether to use a connected socket.
QOSDSCPValue	Used to specify an arbitrary QOS/DSCP setting (optional).
QOSTrafficType	Used to specify QOS/DSCP settings (optional).
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.
CodePage	The system code page used for Unicode to Multibyte translations.