ConnectionStartTimeString (System function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
No edit summary |
||
| (16 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:System:ConnectionStartTimeString subtitle}} | {{Template:System:ConnectionStartTimeString subtitle}} | ||
The purpose of this method is to help provide service time statistics for web requests. | |||
==Syntax== | ==Syntax== | ||
| Line 5: | Line 6: | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%string</th><td>The returned value is the connection start time; it is a string in the format specified by the <var class="term">format</var> argument, if the thread is a TCP/IP server ( | <tr><th>%string</th><td>The returned value is the connection start time; it is a string in the format specified by the <var class="term">format</var> argument, if the thread is a TCP/IP server (for example, <var class="product">Janus Web Server</var>) thread, or the null string otherwise.</td></tr> | ||
<tr><th><var>%(System)</var></th> | <tr><th><var class="nobr">%(System)</var></th> | ||
<td>The class name in parentheses denotes a shared method. <var>ConnectionStartTimeString</var> can also be invoked via a <var>System</var> object variable, which may be null.</td></tr> | <td>The class name in parentheses denotes a [[Notation conventions for methods#Shared methods|shared]] method. <var>ConnectionStartTimeString</var> can also be invoked via a <var>System</var> object variable, which may be null.</td></tr> | ||
<tr><th>format</th> | <tr><th>format</th> | ||
<td><var></var>A [[Datetime string formats|datetime format]] string. | <td><var></var>A [[Datetime string formats|datetime format]] string. This is an optional argument; the default format is <code>YYYYMMDDHHMISSXXX</code>.</td></tr> | ||
</table> | </table> | ||
==Usage notes== | |||
<ul> | |||
<li>The connection time is as of the earliest detection of the connection. For a new | |||
connection, this means when the Janus TCP PST sees the first request for a connection. | |||
<li>To do your own service time calculations, you can do something like: | |||
<p class="code">%serviceTime = %(system):currentTimeMilliseconds - %(system):connectionStartTimeString </p> | |||
A satisfactory result is not guaranteed if this code is run on a VTAM 3270 thread. | |||
</ul> | |||
==See also== | ==See also== | ||
<ul> | |||
<li><var>[[ConnectionStartTimeMilliseconds (System function)|ConnectionStartTimeMilliseconds]]</var> | |||
</ul> | |||
{{Template:System:ConnectionStartTimeString footer}} | {{Template:System:ConnectionStartTimeString footer}} | ||
Latest revision as of 19:05, 3 September 2015
Time of connection start as string (System class)
[Introduced in Sirius Mods 7.8]
The purpose of this method is to help provide service time statistics for web requests.
Syntax
%string = %(System):ConnectionStartTimeString[( [format])] Throws InvalidDateString
Syntax terms
| %string | The returned value is the connection start time; it is a string in the format specified by the format argument, if the thread is a TCP/IP server (for example, Janus Web Server) thread, or the null string otherwise. |
|---|---|
| %(System) | The class name in parentheses denotes a shared method. ConnectionStartTimeString can also be invoked via a System object variable, which may be null. |
| format | A datetime format string. This is an optional argument; the default format is YYYYMMDDHHMISSXXX. |
Usage notes
- The connection time is as of the earliest detection of the connection. For a new connection, this means when the Janus TCP PST sees the first request for a connection.
- To do your own service time calculations, you can do something like:
%serviceTime = %(system):currentTimeMilliseconds - %(system):connectionStartTimeString
A satisfactory result is not guaranteed if this code is run on a VTAM 3270 thread.