services.script

Software Testing Automation Framework (STAF)的开发代码

:xph.<some other type>:exph. is one of the types defined here.
:li.:xph.<Map>:exph. - This represents a set of key/value pairs.  Typically, if
a service is using a :xph.<Map>:exph., then the keys are not static from request
to request.  If the keys are static from request to request, the following data
type is used.
:li.:xph.<Map:<Class>>:exph. - This represents a "map class instance".  A map
class instance is similar to a :xph.<Map>:exph..  However, a map class instance
(technically, the map class of which it is an instance) carries along additional
metadata, which defines the :xph.<Class>:exph. of the map class instance.
This metadata explicitly defines which keys are present in instances of the
map class , as well as information on how to display the keys.  See below
for more information on map classes.
:li.&anyObj. - This is a placeholder that represents any of the above data
types, and is not a true type itself.  It is used to document data for which a
type cannot be determined until runtime.
:eul.

:p.In some cases, the structured data that is returned will be one of a number
of possible values.  In that case, you will see the "or" symbol, '|', used to
list the possible choices.  Two common cases are
:xmp.
<String> | <None>
:exmp.
and
:xmp.
<Map:<Class>> | <None>
:exmp.
:p.In the first case, this means that you will either get a string object
or the special &noneObj. object.  In the second case, it means you will
either get an instance of the specified map class or the special &noneObj.
object.

:p.To further document map classes, each map class will have an associated
table defining the metadata associated with the map class.  The general format
of this table is as follows.

.***************************************
:table cols='* * * *'.
:tcap.Definition of map class <Map Class Name>
:tnote text='Description'.This contains a description of the map class:etnote.
:thd.
:c.Key Name
:c.Display Name
:c.Type
:c.Format / Value
:ethd.
:row.
:c.key1
:c.Key 1 display name
.br
(Key 1 short display name) if one is provided
:c.key1 type
:c.key1 format/value information
:row.
:c....
:c....
:c....
:c....
:row.
:c.keyX
:c.Key X display name
.br
(Key 1 short display name) if one is provided
:c.keyX type
:c.keyX format/value information
:tnote text='Notes'.
Any notes about the definition of the map class.
:etnote.
:etable.
.***************************************
:p.
The "Display Name" field shows the display name for each key, and,
optionally, a "short" display name may be specified (in parenthesis) for a key.
Short display names may be used as column headings by the STAF executable
when displaying the result in a tabular form if the total width of the
display names exceeds 80 characters.
:p.
The "Format / Value" field is used predominantly to document the data
present in &stringObj. objects.  When, the string will contain one of a limited
set of possible values, then the set of possible values will be listed in
this column.  This might look like the following
:xmp.
'Default' | 'Enabled' | 'Disabled'
:exmp.
:p.When the string will be in a particular format, the format will be
documented in this column.  For example, a common string value is a timestamp,
which is documented in the "Format / Value" column as follows
:xmp.
&timestampFormat.
:exmp.

.*
.*---------------------------------------------------------------------
.*
:i3.service help
:h2 id=servicehelp.Service Help
:p.All STAF services provide a HELP command that list basic service syntax
information.
:p.It is recommended that external service writers also provide a HELP
facility.
.*
.*---------------------------------------------------------------------
.*
:h2 id=servicelist.Service list
:p.The following table contains a brief description of the services provided
with STAF.  The chapter that follows provides a detailed explanation of each
service.
:table cols='* 3*'.
:tcap.Service Descriptions
:thd.
:c.Service name
:c.Description String Representation
:ethd.
:row.
:c.DELAY
:c.Provides a means to sleep a specified amount of time
:row.
:c.DIAG
:c.Provides diagnostics services
:row.
:c.ECHO
:c.Echos back a supplied message
:row.
:c.FS
:c.Provides file transfer between systems
:row.
:c.HANDLE
:c.Provides information about existing STAF handles
:row.
:c.HELP
:c.Provides help on STAF error codes
:row.
:c.LOG
:c.Provides robust logging services
:row.
:c.MISC
:c.Handles miscellaneous commands such as displaying the version of STAF that is currently running.
:row.
:c.MONITOR
:c.Provides a means to monitor the status of running programs
:row.
:c.PING
:c.Provides a simple is-alive message
:row.
:c.PROCESS
:c.Handles starting, stopping, and querying processes
:row.
:c.QUEUE
:c.Interacts with STAF queues
:row.
:c.RESPOOL
:c.Manages pools of named elements
:row.
:c.SEM
:c.Provides named event and mutex semaphores
:row.
:c.SERVICE
:c.Provides information on available STAF services
:row.
:c.SHUTDOWN
:c.Provides a means to shutdown STAF and register for shutdown notifications
:row.
:c.TRACE
:c.Provides tracing information for STAF services
:row.
:c.TRUST
:c.Interfaces with STAF's security
:row.
:c.VAR
:c.Allows inspection and manipulation of STAF variable pools
:row.
:c.ZIP
:c.Provides a means to zip/unzip/list/delete PKZip/WinZip compatible archives
:etable.
.*
.*---------------------------------------------------------------------
.*  Services in alphabetical order
.*---------------------------------------------------------------------
:h1 id=serviceref.Service reference
:p.The foundation services that STAF provides are described in this chapter.
For each service the following sections are listed.
:ul compact.
:li.Description - an overview of what the service provides
:li.Registration - documentation on how to register the service.  This section
will only be present for external services.
:li.Variables - describes what variables affect the operation of the service.
This section is not present if the service does not use or depend on any
variables.
:li.Commands - there will be one section for each of the major commands the
service supports.  This section will contain the following subsections.
:ul compact.
:li.Syntax - a description of the command syntax
:li.Security - a statement as to the trust level required to perform this
command
:li.Return Codes - a listing of the return codes this command may return
:li.Results - the format of the result string this command may return.  Note,
information provided in this section pertains to the results from a successful
service request (i.e., a service request with a zero return code).  The results
buffer for a service request with a non-zero return code is generally dependent
on the return code from the request as oppossed to the request itself.
Therefore, if you receive a non-zero return code from a service request, you
should generally look at the documentation for the return codes to determine the
contents of the result buffer.
:li.Examples - examples of how to use this command
:eul.
:eul.
.*---------------------------------------------------------------------
.im DelaySrv
.im DiagSrv
.im EchoSrv
.im FSSrv
.im HandSrv
.im HelpSrv
.im LogSrv
.im MiscSrv
.im MonSrv
.im PingSrv
.im ProcSrv
.im QueueSrv
.im PoolSrv
.*.im RLogSrv
.im SemSrv
.im SrvSrv
.im ShutSrv
.im TraceSrv
.im TrustSrv
.im VarSrv
.im ZipSrv