Search: 
Available in: IP*WORKS!
Syslog Class
SysLog Component [IP*Works! V8]

Properties   Methods   Events   Configuration Settings  

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

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

The Syslog component implements a lightweight BSD syslog client as specified in RFC 3164. The component is used to send and receive BSD system network logging packets.

The first step in using the Syslog component 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 component will parse the headers and message and fire a PacketIn event.

Property List


The following is the full list of the properties of the component with short descriptions. Click on the links for complete descriptions.

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 component with short descriptions. Click on the links for complete descriptions.

Config Sets or retrieves a component 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 component with short descriptions. Click on the links for complete descriptions.

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 component with short descriptions. Click on the links for complete descriptions.

AbsoluteTimeout Determines whether timeouts are inactivity timeouts or absolute timeouts.
CodePage The system code page used for Unicode to Multibyte translations (Windows/COM only).
FirewallData Used to send extra data to the firewall.
InBufferSize The size in bytes of the incoming queue of the socket.
MaxPacketSize The maximum length of the packets that can be received.
OutBufferSize The size in bytes of the outgoing queue of the socket.
QOSFlags Flags determining Quality Of Service bits of packets sent by the socket.
ShareLocalPort If set to True, allows more than one instance of the component to be active on the same local port.
SocketHandle The handle of the main socket used by the component.
UseConnection Determines whether to use a connected socket.
WinsockInfo Identifying information about the loaded Winsock stack (Windows only)
WinsockLoaded Loads and unloads Winsock on demand (Windows only)
WinsockMaxDatagramSize Size in bytes of the largest UDP datagram that can be sent or received (Windows only)
WinsockMaxSockets Maximum number of sockets available to a single process (Windows only)
WinsockPath The path to the Winsock DLL used (Windows only)
WinsockStatus The status of the Winsock stack (Windows only)

| About | Privacy Policy | Terms of Use |
© Copyright 2008 /n software inc.