Return to Unit Reference
Description
Ultibo Services Interface unit
Constants
[Expand]
Ping constants PING_*
PING_DEFAULT_SIZE = 32;
|
Default number of bytes of data to send with echo (Ping) request
|
PING_MAXIMUM_SIZE = 65500;
|
Maximum number of bytes of data to send with echo (Ping) request
|
PING_DEFAULT_COUNT = 4;
|
Default number of echo (ping) requests to send in a sequence
|
PING_DEFAULT_TIMEOUT = 3000;
|
Default time to wait for echo (Ping) response (Milliseconds)
|
[Expand]
NTP specific constants NTP_*
NTP_VERSION_1 = 1;
|
|
NTP_VERSION_2 = 2;
|
|
NTP_VERSION_3 = 3;
|
|
NTP_VERSION_4 = 4;
|
|
|
|
NTP_VERSION_MASK = $07;
|
shl 3
|
|
|
NTP_VERSION = NTP_VERSION_4;
|
Current NTP/SNTP version
|
NTP_MIN_VERSION = NTP_VERSION_2;
|
Minimum acceptable NTP/SNTP version
|
NTP_MAX_VERSION = NTP_VERSION_4;
|
Maximum acceptable NTP/SNTP version
|
|
|
NTP_PACKET_SIZE = 48;
|
SizeOf(TNTPPacket)
|
|
|
NTP_TIMESTAMP_START = 94354848000000000;
|
Offset between 1/1/1601 (Ultibo) and 1/1/1900 (NTP Timestamp)
|
[Expand]
NTP leap indicator NTP_LEAP_*
NTP_LEAP_NONE = 0;
|
|
NTP_LEAP_LAST_61 = 1;
|
|
NTP_LEAP_LAST_59 = 2;
|
|
NTP_LEAP_ALARM = 3;
|
|
|
|
NTP_LEAP_MASK = $03;
|
shl 6
|
[Expand]
NTP mode NTP_MODE_*
NTP_MODE_RESERVED = 0;
|
Reserved
|
NTP_MODE_SYMMETRIC_ACTIVE = 1;
|
Symmetric active
|
NTP_MODE_SYMMETRIC_PASSIVE = 2;
|
Symmetric passive
|
NTP_MODE_CLIENT = 3;
|
Client
|
NTP_MODE_SERVER = 4;
|
Server
|
NTP_MODE_BROADCAST = 5;
|
Broadcast
|
NTP_MODE_CONTROL = 6;
|
Reserved for NTP control message
|
NTP_MODE_PRIVATE = 7;
|
Reserved for private use
|
|
|
NTP_MODE_MASK = $07;
|
shl 0
|
[Expand]
NTP stratum NTP_STRATUM_*
NTP_STRATUM_INVALID = 0;
|
unspecified or invalid
|
NTP_STRATUM_PRIMARY = 1;
|
primary server (e.g., equipped with a GPS receiver)
|
NTP_STRATUM_SECONDARY2 = 2;
|
secondary server (via NTP)
|
NTP_STRATUM_SECONDARY3 = 3;
|
secondary server (via NTP)
|
NTP_STRATUM_SECONDARY4 = 4;
|
secondary server (via NTP)
|
NTP_STRATUM_SECONDARY5 = 5;
|
secondary server (via NTP)
|
NTP_STRATUM_SECONDARY6 = 6;
|
secondary server (via NTP)
|
NTP_STRATUM_SECONDARY7 = 7;
|
secondary server (via NTP)
|
NTP_STRATUM_SECONDARY8 = 8;
|
secondary server (via NTP)
|
NTP_STRATUM_SECONDARY9 = 9;
|
secondary server (via NTP)
|
NTP_STRATUM_SECONDARY10 = 10;
|
secondary server (via NTP)
|
NTP_STRATUM_SECONDARY11 = 11;
|
secondary server (via NTP)
|
NTP_STRATUM_SECONDARY12 = 12;
|
secondary server (via NTP)
|
NTP_STRATUM_SECONDARY13 = 13;
|
secondary server (via NTP)
|
NTP_STRATUM_SECONDARY14 = 14;
|
secondary server (via NTP)
|
NTP_STRATUM_SECONDARY15 = 15;
|
secondary server (via NTP)
|
NTP_STRATUM_UNSYNCRONIZED = 16;
|
unsynchronized
|
NTP_STRATUM_RESERVED = 17;
|
reserved
|
[Expand]
Telnet character TELNET_CHAR_*
TELNET_CHAR_NUL = #0;
|
|
TELNET_CHAR_CR = #13;
|
|
TELNET_CHAR_LF = #10;
|
|
TELNET_CHAR_BELL = #7;
|
|
TELNET_CHAR_TAB = #9;
|
|
TELNET_CHAR_ESC = #27;
|
|
TELNET_CHAR_BACKSPACE = #127;
|
|
|
|
TELNET_BUFFER_SIZE = SIZE_2K;
|
|
[Expand]
Telnet escape sequence TELNET_SEQUENCE_*
TELNET_SEQUENCE_UP_ARROW = #27#91#65;
|
ESC[A
|
TELNET_SEQUENCE_DOWN_ARROW = #27#91#66;
|
ESC[B
|
TELNET_SEQUENCE_RIGHT_ARROW = #27#91#67;
|
ESC[C
|
TELNET_SEQUENCE_LEFT_ARROW = #27#91#68;
|
ESC[D
|
|
|
TELNET_SEQUENCE_HOME = #27#91#49#126;
|
ESC[1~
|
TELNET_SEQUENCE_INSERT = #27#91#50#126;
|
ESC[2~
|
TELNET_SEQUENCE_DELETE = #27#91#51#126;
|
ESC[3~
|
TELNET_SEQUENCE_END = #27#91#52#126;
|
ESC[4~
|
TELNET_SEQUENCE_PGUP = #27#91#53#126;
|
ESC[5~
|
TELNET_SEQUENCE_PGDN = #27#91#54#126;
|
ESC[6~
|
|
|
TELNET_SEQUENCE_F1 = #27#91#49#49#126;
|
ESC[11~
|
TELNET_SEQUENCE_F2 = #27#91#49#50#126;
|
ESC[12~
|
TELNET_SEQUENCE_F3 = #27#91#49#51#126;
|
ESC[13~
|
TELNET_SEQUENCE_F4 = #27#91#49#52#126;
|
ESC[14~
|
TELNET_SEQUENCE_F5 = #27#91#49#53#126;
|
ESC[15~
|
TELNET_SEQUENCE_F6 = #27#91#49#55#126;
|
ESC[17~
|
TELNET_SEQUENCE_F7 = #27#91#49#56#126;
|
ESC[18~
|
TELNET_SEQUENCE_F8 = #27#91#49#57#126;
|
ESC[19~
|
TELNET_SEQUENCE_F9 = #27#91#50#48#126;
|
ESC[20~
|
TELNET_SEQUENCE_F10 = #27#91#50#49#126;
|
ESC[21~
|
[Expand]
Telnet buffer TELNET_BUFFER_*
TELNET_BUFFER_SIZE = SIZE_2K;
|
|
[Expand]
Telnet state TELNET_STATE_*
TELNET_STATE_NONE = $00000000;
|
|
TELNET_STATE_TRANSMIT_BINARY = $00000001;
|
|
TELNET_STATE_ECHO = $00000002;
|
|
TELNET_STATE_SUPPRESS_GA = $00000004;
|
|
TELNET_STATE_TERMINAL_TYPE = $00000008;
|
|
TELNET_STATE_WINDOW_SIZE = $00000010;
|
|
TELNET_STATE_TERMINAL_SPEED = $00000020;
|
|
TELNET_STATE_NEW_ENVIRONMENT = $00000040;
|
|
[Expand]
Telnet command TELNET_COMMAND_*
TELNET_COMMAND_EOR = 239;
|
0xEF end of record command
|
TELNET_COMMAND_SE = 240;
|
0xF0 end of subnegotiations command
|
TELNET_COMMAND_NOP = 241;
|
0xF1 no operation command
|
TELNET_COMMAND_DM = 242;
|
0xF2 data mark command
|
TELNET_COMMAND_BRK = 243;
|
0xF3 break NVT charater
|
TELNET_COMMAND_IP = 244;
|
0xF4 interrupt process command
|
TELNET_COMMAND_AO = 245;
|
0xF5 abort output command
|
TELNET_COMMAND_AYT = 246;
|
0xF6 are you there command
|
TELNET_COMMAND_EC = 247;
|
0xF7 erase character command
|
TELNET_COMMAND_EL = 248;
|
0xF8 erase line command
|
TELNET_COMMAND_GA = 249;
|
0xF9 go ahead command
|
TELNET_COMMAND_SB = 250;
|
0xFA begin option subnegotiations command
|
TELNET_COMMAND_WILL = 251;
|
0xFB will enable option
|
TELNET_COMMAND_WONT = 252;
|
0xFC won't enable option
|
TELNET_COMMAND_DO = 253;
|
0xFD request other party enables option
|
TELNET_COMMAND_DONT = 254;
|
0xFE request other party doesn't enable option
|
TELNET_COMMAND_IAC = 255;
|
0xFF interpret as command
|
[Expand]
Telnet option TELNET_OPTION_*
TELNET_OPTION_TRANSMIT_BINARY = 0;
|
0x00 transmit binary option
|
TELNET_OPTION_ECHO = 1;
|
0x01 echo option
|
TELNET_OPTION_SUPPRESS_GA = 3;
|
0x03 suppress go ahead option
|
TELNET_OPTION_TERMINAL_TYPE = 24;
|
0x18 terminal type
|
TELNET_OPTION_WINDOW_SIZE = 31;
|
0x1F negotiate window size
|
TELNET_OPTION_TERMINAL_SPEED = 32;
|
0x20 terminal speed
|
TELNET_OPTION_NEW_ENVIRONMENT = 39;
|
0x27 new environment
|
[Expand]
SysLog logging SYSLOG_LOGGING_*
SYSLOG_LOGGING_DESCRIPTION = 'SysLog Logging';
|
|
[Expand]
SysLog facility code SYSLOG_FACILITY_*
SYSLOG_FACILITY_KERNEL = 0;
|
kernel messages
|
SYSLOG_FACILITY_USER = 1;
|
user-level messages
|
SYSLOG_FACILITY_MAIL = 2;
|
mail system
|
SYSLOG_FACILITY_SYSTEM = 3;
|
system daemons
|
SYSLOG_FACILITY_SECURITY = 4;
|
security/authorization messages (note 1)
|
SYSLOG_FACILITY_SYSLOG = 5;
|
messages generated internally by syslogd
|
SYSLOG_FACILITY_PRINTER = 6;
|
line printer subsystem
|
SYSLOG_FACILITY_NEWS = 7;
|
network news subsystem
|
SYSLOG_FACILITY_UUCP = 8;
|
UUCP subsystem
|
SYSLOG_FACILITY_CLOCK = 9;
|
clock daemon (note 2)
|
SYSLOG_FACILITY_AUTH = 10;
|
security/authorization messages (note 1)
|
SYSLOG_FACILITY_FTP = 11;
|
FTP daemon
|
SYSLOG_FACILITY_NTP = 12;
|
NTP subsystem
|
SYSLOG_FACILITY_AUDIT = 13;
|
log audit (note 1)
|
SYSLOG_FACILITY_ALERT = 14;
|
log alert (note 1)
|
SYSLOG_FACILITY_CLOCK2 = 15;
|
clock daemon (note 2)
|
SYSLOG_FACILITY_LOCAL0 = 16;
|
local use 0 (local0)
|
SYSLOG_FACILITY_LOCAL1 = 17;
|
local use 1 (local1)
|
SYSLOG_FACILITY_LOCAL2 = 18;
|
local use 2 (local2)
|
SYSLOG_FACILITY_LOCAL3 = 19;
|
local use 3 (local3)
|
SYSLOG_FACILITY_LOCAL4 = 20;
|
local use 4 (local4)
|
SYSLOG_FACILITY_LOCAL5 = 21;
|
local use 5 (local5)
|
SYSLOG_FACILITY_LOCAL6 = 22;
|
local use 6 (local6)
|
SYSLOG_FACILITY_LOCAL7 = 23;
|
local use 7 (local7)
|
[Expand]
SysLog severity code SYSLOG_SEVERITY_*
SYSLOG_SEVERITY_EMERGENCY = 0;
|
Emergency: system is unusable
|
SYSLOG_SEVERITY_ALERT = 1;
|
Alert: action must be taken immediately
|
SYSLOG_SEVERITY_CRITICAL = 2;
|
Critical: critical conditions
|
SYSLOG_SEVERITY_ERROR = 3;
|
Error: error conditions
|
SYSLOG_SEVERITY_WARNING = 4;
|
Warning: warning conditions
|
SYSLOG_SEVERITY_NOTICE = 5;
|
Notice: normal but significant condition
|
SYSLOG_SEVERITY_INFORMATION = 6;
|
Informational: informational messages
|
SYSLOG_SEVERITY_DEBUG = 7;
|
Debug: debug-level messages
|
[Expand]
Service logging SERVICE_LOG_*
SERVICE_LOG_LEVEL_DEBUG = LOG_LEVEL_DEBUG;
|
Service debugging messages
|
SERVICE_LOG_LEVEL_INFO = LOG_LEVEL_INFO;
|
Service informational messages, such as a service being created or destroyed
|
SERVICE_LOG_LEVEL_WARN = LOG_LEVEL_WARN;
|
Service warning messages
|
SERVICE_LOG_LEVEL_ERROR = LOG_LEVEL_ERROR;
|
Service error messages
|
SERVICE_LOG_LEVEL_NONE = LOG_LEVEL_NONE;
|
No Service messages
|
Type definitions
NTP short
[Expand]
PNTPShort = ^TNTPShort;
TNTPShort = packed record
| Note: NTP Short Format
|
Seconds:Word;
|
Seconds
|
Fraction:Word;
|
Fraction
|
NTP timestamp
[Expand]
PNTPTimestamp = ^TNTPTimestamp;
TNTPTimestamp = packed record
| Note: NTP Timestamp Format
|
Seconds:LongWord;
|
Seconds
|
Fraction:LongWord;
|
Seconds Fraction (0-padded)
|
NTP date format
[Expand]
PNTPDate = ^TNTPDate;
TNTPDate = packed record
EraNumber:LongWord;
|
Era Number
|
EraOffset:LongWord;
|
Era Offset
|
Fraction:Int64;
|
Fraction
|
NTP packet
[Expand]
PNTPPacket = ^TNTPPacket;
TNTPPacket = packed record
LeapVersionMode:Byte;
|
Leap Indicator (2 bits)/Version (3 bits)/Mode (3 bits)
|
Stratum:Byte;
|
This is an eight-bit unsigned integer indicating the stratum
|
PollInterval:Byte;
|
This is an eight-bit unsigned integer used as an exponent of two, where the resulting value is the maximum interval between successive messages in seconds.
|
Precision:ShortInt;
|
This is an eight-bit signed integer used as an exponent of two, where the resulting value is the precision of the system clock in seconds.
|
RootDelay:LongInt;
|
This is a 32-bit signed fixed-point number indicating the total roundtrip delay to the primary reference source, in seconds with the fraction point between bits 15 and 16.
|
RootDispersion:LongWord;
|
This is a 32-bit unsigned fixed-point number indicating the maximum error due to the clock frequency tolerance, in seconds with the fraction point between bits 15 and 16.
|
ReferenceIdentifier:array[0..3] of Byte;
|
This is a 32-bit bitstring identifying the particular reference source
|
ReferenceTimestamp:TNTPTimestamp;
|
This field is the time the system clock was last set or corrected, in 64-bit timestamp format.
|
OriginateTimestamp:TNTPTimestamp;
|
This is the time at which the request departed the client for the server, in 64-bit timestamp format.
|
ReceiveTimestamp:TNTPTimestamp;
|
This is the time at which the request arrived at the server or the reply arrived at the client, in 64-bit timestamp format.
|
TransmitTimestamp:TNTPTimestamp;
|
This is the time at which the request departed the client or the reply departed the server, in 64-bit timestamp format.
|
KeyIdentifier:LongWord;
|
Optional for NTP authentication
|
MessageDigest:array[0..15] of Byte;
|
Optional for NTP authentication
|
Syslog logging
[Expand]
PSyslogLogging = ^TSyslogLogging;
TSyslogLogging = record
| Logging Properties
|
Logging:TLoggingDevice;
|
|
| Syslog Properties
|
Client:TSyslogClient;
|
|
Telnet host event
TTelnetHostEvent = function(AConnection:TTelnetConnection):Boolean of Object;
|
|
Telnet count event
TTelnetCountEvent = function(AConnection:TTelnetConnection):Boolean of Object;
|
|
Telnet initialize event
TTelnetInitEvent = function(AConnection:TTelnetConnection):Boolean of Object;
|
|
Telnet character event
TTelnetCharEvent = function(AConnection:TTelnetConnection; AChar:Char):Boolean of Object;
|
|
Telnet command event
TTelnetCommandEvent = function(AConnection:TTelnetConnection; ACommand,AOption:Byte; AData:Pointer; ASize:LongWord):Boolean of Object;
|
|
Telnet connection event
TTelnetConnectionEvent = procedure(AConnection:TTelnetConnection) of Object;
|
|
Class definitions
Ping classes
Telnet classes
SysLog classes
Public variables
Service logging
SERVICE_DEFAULT_LOG_LEVEL:LongWord = SERVICE_LOG_LEVEL_DEBUG;
|
Minimum level for Service messages. Only messages with level greater than or equal to this will be printed.
|
SERVICE_LOG_ENABLED:Boolean;
|
|
Function declarations
Initialization functions
[Expand]
procedure ServicesInit;
Description: To be documented
NTP functions
[Expand]
procedure NTPUpdateTime(Client:TNTPClient);
Description: To be documented
[Expand]
function WholeSeconds(Time:Int64):Int64;
Description: Truncate a time value in 100ns intervals to whole seconds only
SysLog functions
[Expand]
function SysLogLoggingStart(Logging:PLoggingDevice):LongWord;
Description: To be documented
[Expand]
function SysLogLoggingStop(Logging:PLoggingDevice):LongWord;
Description: To be documented
[Expand]
function SysLogLoggingOutput(Logging:PLoggingDevice; const Data:String):LongWord;
Description: To be documented
[Expand]
function SysLogLoggingOutputEx(Logging:PLoggingDevice; Facility,Severity:LongWord; const Tag,Content:String):LongWord;
Description: To be documented
[Expand]
function SysLogLoggingGetTarget(Logging:PLoggingDevice):String;
Description: To be documented
[Expand]
function SysLogLoggingSetTarget(Logging:PLoggingDevice; const Target:String):LongWord;
Description: To be documented
Service helper functions
[Expand]
procedure ServiceLog(Level:LongWord; const AText:String);
Description: To be documented
[Expand]
procedure ServiceLogInfo(const AText:String); inline;
Description: To be documented
[Expand]
procedure ServiceLogWarn(const AText:String); inline;
Description: To be documented
[Expand]
procedure ServiceLogError(const AText:String); inline;
Description: To be documented
[Expand]
procedure ServiceLogDebug(const AText:String); inline;
Description: To be documented
NTP helper functions
[Expand]
function NTPTimestampToHost(const Timestamp:TNTPTimestamp):TNTPTimestamp;
Description: Convert an NTP Timestamp to Host order
[Expand]
function NTPTimestampToNetwork(const Timestamp:TNTPTimestamp):TNTPTimestamp;
Description: Convert an NTP Timestamp to Network order
[Expand]
function NTPTimestampAdd(const Timestamp1,Timestamp2:TNTPTimestamp):TNTPTimestamp;
Description: To be documented
| Note
|
Expects Timestamp to be in Network order. Returns Timestamp in Network order.
|
[Expand]
function NTPTimestampSubtract(const Timestamp1,Timestamp2:TNTPTimestamp):TNTPTimestamp;
Description: To be documented
| Note
|
Expects Timestamp to be in Network order. Returns Timestamp in Network order.
|
[Expand]
function NTPTimestampDivide(const Timestamp:TNTPTimestamp; Divisor:LongWord):TNTPTimestamp;
Description: To be documented
| Note
|
Expects Timestamp to be in Network order. Returns Timestamp in Network order.
|
[Expand]
function ClockTimeToNTPTimestamp(const Time:Int64):TNTPTimestamp;
Description: To be documented
| Note
|
Returns Timestamp in Network order
|
[Expand]
function NTPTimestampToClockTime(const Timestamp:TNTPTimestamp):Int64;
Description: To be documented
| Note
|
Expects Timestamp to be in Network order
|
[Expand]
function NTPTimestampToString(const Timestamp:TNTPTimestamp):String;
Description: To be documented
| Note
|
Expects Timestamp to be in Network order
|
Telnet helper functions
[Expand]
function TelnetCommandToString(Command:Byte):String;
Description: To be documented
[Expand]
function TelnetCommandHasOption(Command:Byte):Boolean;
Description: To be documented
[Expand]
function TelnetOptionToString(Option:Byte):String;
Description: To be documented
SysLog helper functions
[Expand]
function FileTimeToSysLogDateTime(const AFileTime:TFileTime):String;
Description: To be documented
[Expand]
function LoggingFacilityToSysLogFacility(Facility:LongWord):LongWord;
Description: To be documented
[Expand]
function LoggingSeverityToSysLogSeverity(Severity:LongWord):LongWord;
Description: To be documented
Return to Unit Reference
