Difference between revisions of "Unit Services"

From Ultibo.org
Jump to: navigation, search
Line 764: Line 764:
  
  
−
'''Ping client'''
+
'''Ping classes'''
  
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
+
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−
 
+
−
<code>TPingClient = class(TWinsock2RAWClient)</code>
+
−
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
+
−
{| class="wikitable" style="font-size: 14px; background: white;"
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
 
|-
 
|-
−
|colspan="2"|&nbsp;
+
| [[TPingClient|<code>TPingClient = class(TWinsock2RAWClient)</code>]]
 
|-
 
|-
 
|}
 
|}
−
</div></div>
+
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−
 
+
−
'''NTP client'''
+
−
 
+
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
+
−
 
+
−
<code>TNTPClient = class(TWinsock2UDPClient)</code>
+
−
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
+
−
{| class="wikitable" style="font-size: 14px; background: white;"
+
 
|-
 
|-
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
| [[TNTPClient|<code>TNTPClient = class(TWinsock2UDPClient)</code>]]
−
|-
+
−
| <code>constructor Create;</code>
+
−
| style="width: 50%;"|&nbsp;
+
−
|-
+
−
| <code>destructor Destroy; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
+
−
|-
+
−
| <code>FLock:TMutexHandle;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>FPollInterval:LongWord;</code>
+
−
| How often to poll the server (in seconds)
+
−
|-
+
−
| <code>FPollTimeout:LongWord;</code>
+
−
| How long before receive or send timeout occurs (in milliseconds)
+
−
|-
+
−
| <code>FPollRetries:LongWord;</code>
+
−
| How many times to retry a poll
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>FRetryTimeout:LongWord;</code>
+
−
| How long to wait between poll retries (in milliseconds)
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>FInitialClockGet:Boolean;</code>
+
−
| Has the time been obtained at least once
+
−
|-
+
−
| <code>FInitialClockCount:LongWord;</code>
+
−
| How many times have we tried to obtain the initial clock
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>FTimerHandle:TTimerHandle;</code>
+
−
| Handle for the NTP update timer
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function AcquireLock:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function ReleaseLock:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>procedure SetPollInterval(APollInterval:LongWord);</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure SetPollTimeout(APollTimeout:LongWord);</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure SetPollRetries(APollRetries:LongWord);</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>procedure SetRetryTimeout(ARetryTimeout:LongWord);</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>procedure SetInitialClockGet(AInitialClockGet:Boolean);</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure SetInitialClockCount(AInitialClockCount:LongWord);</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>procedure SetTimerHandle(ATimerHandle:TTimerHandle);</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
−
|-
+
−
| <code>property PollInterval:LongWord read FPollInterval write SetPollInterval;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property PollTimeout:LongWord read FPollTimeout write SetPollTimeout;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property PollRetries:LongWord read FPollRetries write SetPollRetries;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>property RetryTimeout:LongWord read FRetryTimeout write SetRetryTimeout;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>property InitialClockGet:Boolean read FInitialClockGet write SetInitialClockGet;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property InitialClockCount:LongWord read FInitialClockCount write SetInitialClockCount;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>property TimerHandle:TTimerHandle read FTimerHandle write SetTimerHandle;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function GetTime:Int64;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>procedure IncrementInitialClockCount;</code>
+
−
| &nbsp;
+
 
|-
 
|-
 
|}
 
|}
−
</div></div>
 
  
−
'''Telnet buffer'''
+
'''Telnet classes'''
  
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
+
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−
 
+
−
<code>TTelnetBuffer = class(TObject)</code>
+
−
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
+
−
{| class="wikitable" style="font-size: 14px; background: white;"
+
 
|-
 
|-
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
| [[TTelnetBuffer|<code>TTelnetBuffer = class(TObject)</code>]]
−
|-
+
−
| <code>constructor Create(ASize:LongWord);</code>
+
−
| style="width: 50%;"|&nbsp;
+
−
|-
+
−
| <code>destructor Destroy; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
+
−
|-
+
−
| <code>FLock:TCriticalSectionHandle;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>FData:Pointer;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>FSize:LongWord;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>FCount:LongWord;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>FStart:LongWord;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function AcquireLock:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function ReleaseLock:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function GetCount:LongWord;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
−
|-
+
−
| <code>property Count:LongWord read GetCount;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function ReadData:Char;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function WriteData(AChar:Char):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function WriteLock(var ASize:LongWord):Pointer;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function WriteUnlock(ACount:LongWord):Boolean;</code>
+
−
| &nbsp;
+
 
|-
 
|-
 
|}
 
|}
−
</div></div>
+
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−
 
+
−
'''Telnet connection'''
+
−
 
+
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
+
−
 
+
−
<code>TTelnetConnection = class(TListObject)</code>
+
−
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
+
−
{| class="wikitable" style="font-size: 14px; background: white;"
+
 
|-
 
|-
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
| [[TTelnetConnection|<code>TTelnetConnection = class(TListObject)</code>]]
−
|-
+
−
| <code>constructor Create;</code>
+
−
| style="width: 50%;"|&nbsp;
+
−
|-
+
−
| <code>destructor Destroy; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
+
−
|-
+
−
| <code>FLock:TCriticalSectionHandle;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>FHandle:LongWord;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>FRxByteCount:Int64;</code>
+
−
| Bytes Recv Count from Connection
+
−
|-
+
−
| <code>FTxByteCount:Int64;</code>
+
−
| Bytes Sent Count to Connection
+
−
|-
+
−
| <code>FRequestCount:Int64;</code>
+
−
| Requests Recv Count from Connection
+
−
|-
+
−
| <code>FResponseCount:Int64;</code>
+
−
| Responses Sent Count to Connection
+
−
|-
+
−
| <code>FRequestTime:TDateTime;</code>
+
−
| Last Request Time
+
−
|-
+
−
| <code>FResponseTime:TDateTime;</code>
+
−
| Last Response Time
+
−
|-
+
−
| <code>FRemoteAddress:String;</code>
+
−
| Address of Remote Client
+
−
|-
+
−
| <code>FLocalState:LongWord;</code>
+
−
| Local connection state (eg TELNET_STATE_ECHO)
+
−
|-
+
−
| <code>FRemoteState:LongWord;</code>
+
−
| Remote connection state (eg TELNET_STATE_ECHO)
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>FData:Pointer;</code>
+
−
| Private data for application
+
−
|-
+
−
| <code>FThread:TThread;</code>
+
−
| TWinsock2TCPServerThread
+
−
|-
+
−
| <code>FBuffer:TTelnetBuffer;</code>
+
−
| Buffer for received data
+
−
|-
+
−
| <code>FListener:TTelnetListener;</code>
+
−
| Listener for Connection
+
−
|-
+
−
|colspan="2"|&nbsp; 
+
−
|-
+
−
| <code>function AcquireLock:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function ReleaseLock:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp; 
+
−
|-
+
−
| <code>procedure SetHandle(AHandle:LongWord);</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function GetRxByteCount:Int64;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure SetRxByteCount(const ARxByteCount:Int64);</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function GetTxByteCount:Int64;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure SetTxByteCount(const ATxByteCount:Int64);</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function GetRequestCount:Int64;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure SetRequestCount(const ARequestCount:Int64);</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function GetResponseCount:Int64;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure SetResponseCount(const AResponseCount:Int64);</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function GetRequestTime:TDateTime;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure SetRequestTime(const ARequestTime:TDateTime);</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function GetResponseTime:TDateTime;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure SetResponseTime(const AResponseTime:TDateTime);</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function GetRemoteAddress:String;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure SetRemoteAddress(const ARemoteAddress:String);</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure SetLocalState(ALocalState:LongWord);</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure SetRemoteState(ARemoteState:LongWord);</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>procedure SetData(AData:Pointer);</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure SetThread(AThread:TThread);</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure SetListener(AListener:TTelnetListener);</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
−
|-
+
−
| <code>property Handle:LongWord read FHandle write SetHandle;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property RxByteCount:Int64 read GetRxByteCount write SetRxByteCount;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property TxByteCount:Int64 read GetTxByteCount write SetTxByteCount;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property RequestCount:Int64 read GetRequestCount write SetRequestCount;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property ResponseCount:Int64 read GetResponseCount write SetResponseCount;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property RequestTime:TDateTime read GetRequestTime write SetRequestTime;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property ResponseTime:TDateTime read GetResponseTime write SetResponseTime;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property RemoteAddress:String read GetRemoteAddress write SetRemoteAddress;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property LocalState:LongWord read FLocalState write SetLocalState;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property RemoteState:LongWord read FRemoteState write SetRemoteState;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>property Data:Pointer read FData write SetData;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property Thread:TThread read FThread  write SetThread;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property Buffer:TTelnetBuffer read FBuffer;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property Listener:TTelnetListener read FListener write SetListener;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>procedure IncrementRxByteCount(const ARxByteCount:Int64);</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure IncrementTxByteCount(const ATxByteCount:Int64);</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure IncrementRequestCount;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure IncrementResponseCount;</code>
+
−
| &nbsp;
+
 
|-
 
|-
 
|}
 
|}
−
</div></div>
+
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−
 
+
−
'''Telnet listener'''
+
−
 
+
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
+
−
 
+
−
<code>TTelnetListener = class(TWinsock2TCPListener)</code>
+
−
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
+
−
{| class="wikitable" style="font-size: 14px; background: white;"
+
 
|-
 
|-
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
| [[TTelnetListener|<code>TTelnetListener = class(TWinsock2TCPListener)</code>]]
−
|-
+
−
| <code>constructor Create;</code>
+
−
| style="width: 50%;"|&nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
+
−
|-
+
−
| <code>FOnConnected:TTelnetConnectionEvent;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>FOnDisconnected:TTelnetConnectionEvent;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>FOnCheckHost:TTelnetHostEvent;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>FOnCheckCount:TTelnetCountEvent;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>FOnInit:TTelnetInitEvent;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>FOnChar:TTelnetCharEvent;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>FOnCommand:TTelnetCommandEvent;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''protected'''</div>
+
−
|-
+
−
| <code>procedure DoConnect(AThread:TWinsock2TCPServerThread); override;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure DoDisconnect(AThread:TWinsock2TCPServerThread); override;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function DoCheckHost(AThread:TWinsock2TCPServerThread):Boolean; virtual;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function DoCheckCount(AThread:TWinsock2TCPServerThread):Boolean; virtual;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function DoExecute(AThread:TWinsock2TCPServerThread):Boolean; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>procedure DoInit(AThread:TWinsock2TCPServerThread);</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure DoChar(AThread:TWinsock2TCPServerThread; AChar:Char);</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure DoCommand(AThread:TWinsock2TCPServerThread; ACommand,AOption:Byte; AData:Pointer; ASize:LongWord);</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function SendEcho(AThread:TWinsock2TCPServerThread; AChar:Char):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
−
|-
+
−
| <code>property OnConnected:TTelnetConnectionEvent read FOnConnected write FOnConnected;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property OnDisconnected:TTelnetConnectionEvent read FOnDisconnected write FOnDisconnected;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>property OnCheckHost:TTelnetHostEvent read FOnCheckHost write FOnCheckHost;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property OnCheckCount:TTelnetCountEvent read FOnCheckCount write FOnCheckCount;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>property OnInit:TTelnetInitEvent read FOnInit write FOnInit;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property OnChar:TTelnetCharEvent read FOnChar write FOnChar;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property OnCommand:TTelnetCommandEvent read FOnCommand write FOnCommand;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function GetChar(AThread:TWinsock2TCPServerThread; var AChar:Char):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function SendChar(AThread:TWinsock2TCPServerThread; AChar:Char):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function SendText(AThread:TWinsock2TCPServerThread; const AText:String):Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function SendCommand(AThread:TWinsock2TCPServerThread; ACommand,AOption:Byte; AData:Pointer; ASize:LongWord):Boolean;</code>
+
−
| &nbsp;
+
 
|-
 
|-
 
|}
 
|}
−
</div></div>
 
  
−
'''SysLog client'''
+
'''SysLog classes'''
  
−
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
+
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
−
 
+
−
<code>TSyslogClient = class(TObject)</code>
+
−
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
+
−
{| class="wikitable" style="font-size: 14px; background: white;"
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
−
|-
+
−
| <code>constructor Create;</code>
+
−
| style="width: 50%;"|&nbsp;
+
−
|-
+
−
| <code>destructor Destroy; override;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''private'''</div>
+
−
|-
+
−
| <code>FLock:TMutexHandle;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>FProtocol:LongWord;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>FBoundPort:Word;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>FRemoteHost:String;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>FRemotePort:Word;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>FOctetCounting:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>FUDPClient:TWinsock2UDPClient;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>FTCPClient:TWinsock2TCPClient;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>function AcquireLock:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function ReleaseLock:Boolean;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
−
|-
+
−
| <code>procedure SetProtocol(AProtocol:LongWord);</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure SetBoundPort(ABoundPort:Word);</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function GetRemoteHost:String;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure SetRemoteHost(const ARemoteHost:String);</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure SetRemotePort(ARemotePort:Word);</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>procedure SetOctetCounting(AOctetCounting:Boolean);</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''protected'''</div>
+
−
|-
+
−
| <code>function GetPriority(AFacility,ASeverity:LongWord):String;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>function GetMessage(const APriority,AAddress,ATag,AContent:String):String;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|<div style="font-family: monospace,courier;">'''public'''</div>
+
−
|-
+
−
| <code>property Protocol:LongWord read FProtocol write SetProtocol;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property BoundPort:Word read FBoundPort write SetBoundPort;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property RemoteHost:String read GetRemoteHost write SetRemoteHost;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property RemotePort:Word read FRemotePort write SetRemotePort;</code>
+
−
| &nbsp;
+
−
|-
+
−
| <code>property OctetCounting:Boolean read FOctetCounting write SetOctetCounting;</code>
+
−
| &nbsp;
+
−
|-
+
−
|colspan="2"|&nbsp;
+
 
|-
 
|-
−
| <code>function SendMessage(AFacility,ASeverity:LongWord; const ATag,AContent:String):LongWord;</code>
+
| [[TSyslogClient|<code>TSyslogClient = class(TObject)</code>]]
−
| &nbsp;
+
 
|-
 
|-
 
|}
 
|}
−
</div></div> 
 
 
<br />
 
<br />
  

Revision as of 00:34, 29 May 2018

Return to Unit Reference


Description

Ultibo Services interface unit

To be documented

Constants


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)


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


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


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


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;  


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~


Telnet buffer TELNET_BUFFER_*
TELNET_BUFFER_SIZE = SIZE_2K;  


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;  


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


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


SysLog logging SYSLOG_LOGGING_*
SYSLOG_LOGGING_DESCRIPTION = 'SysLog Logging';  


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)


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


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

PNTPShort = ^TNTPShort;

TNTPShort = packed record

Note: NTP Short Format
Seconds:Word; Seconds
Fraction:Word; Fraction

NTP timestamp

PNTPTimestamp = ^TNTPTimestamp;

TNTPTimestamp = packed record

Note: NTP Timestamp Format
Seconds:LongWord; Seconds
Fraction:LongWord; Seconds Fraction (0-padded)

NTP date format

PNTPDate = ^TNTPDate;

TNTPDate = packed record

EraNumber:LongWord; Era Number
EraOffset:LongWord; Era Offset
Fraction:Int64; Fraction

NTP packet

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

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

TPingClient = class(TWinsock2RAWClient)
TNTPClient = class(TWinsock2UDPClient)

Telnet classes

TTelnetBuffer = class(TObject)
TTelnetConnection = class(TListObject)
TTelnetListener = class(TWinsock2TCPListener)

SysLog classes

TSyslogClient = class(TObject)


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 

procedure ServicesInit;
Description: To be documented
Note None documented


NTP functions 

procedure NTPUpdateTime(Client:TNTPClient);
Description: To be documented
Note None documented


SysLog functions 

function SysLogLoggingStart(Logging:PLoggingDevice):LongWord;
Description: To be documented
Note None documented 


function SysLogLoggingStop(Logging:PLoggingDevice):LongWord;
Description: To be documented
Note None documented 


function SysLogLoggingOutput(Logging:PLoggingDevice; const Data:String):LongWord;
Description: To be documented
Note None documented 


function SysLogLoggingOutputEx(Logging:PLoggingDevice; Facility,Severity:LongWord; const Tag,Content:String):LongWord;
Description: To be documented
Note None documented 


function SysLogLoggingGetTarget(Logging:PLoggingDevice):String;
Description: To be documented
Note None documented 


function SysLogLoggingSetTarget(Logging:PLoggingDevice; const Target:String):LongWord;
Description: To be documented
Note None documented


Service helper functions 

procedure ServiceLog(Level:LongWord; const AText:String);
Description: To be documented
Note None documented 


procedure ServiceLogInfo(const AText:String); inline;
Description: To be documented
Note None documented 


procedure ServiceLogWarn(const AText:String); inline;
Description: To be documented
Note None documented 


procedure ServiceLogError(const AText:String); inline;
Description: To be documented
Note None documented 


procedure ServiceLogDebug(const AText:String); inline;
Description: To be documented
Note None documented


NTP helper functions 

function NTPTimestampToHost(const Timestamp:TNTPTimestamp):TNTPTimestamp;
Description: Convert an NTP Timestamp to Host order
Note None documented 


function NTPTimestampToNetwork(const Timestamp:TNTPTimestamp):TNTPTimestamp;
Description: Convert an NTP Timestamp to Network order
Note None documented 


function NTPTimestampAdd(const Timestamp1,Timestamp2:TNTPTimestamp):TNTPTimestamp;
Description: To be documented
Note Expects Timestamp to be in Host order 


function NTPTimestampSubtract(const Timestamp1,Timestamp2:TNTPTimestamp):TNTPTimestamp;
Description: To be documented
Note Expects Timestamp to be in Host order 


function ClockTimeToNTPTimestamp(const Time:Int64):TNTPTimestamp;
Description: To be documented
Note Returns Timestamp in Host order 


function NTPTimestampToClockTime(const Timestamp:TNTPTimestamp):Int64;
Description: To be documented
Note Expects Timestamp to be in Host order


Telnet helper functions 

function TelnetCommandToString(Command:Byte):String;
Description: To be documented
Note None documented 


function TelnetCommandHasOption(Command:Byte):Boolean;
Description: To be documented
Note None documented 


function TelnetOptionToString(Option:Byte):String;
Description: To be documented
Note None documented


SysLog helper functions 

function FileTimeToSysLogDateTime(const AFileTime:TFileTime):String;
Description: To be documented
Note None documented 


function LoggingFacilityToSysLogFacility(Facility:LongWord):LongWord;
Description: To be documented
Note None documented 


function LoggingSeverityToSysLogSeverity(Severity:LongWord):LongWord;
Description: To be documented
Note None documented


Return to Unit Reference

Retrieved from "https://ultibo.org/mediawiki_ultibo_org/index.php?title=Unit_Services&oldid=4275"