semsrv.script

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

:c.Format / Value
:ethd.
:row.
:c.state
:c.State
:c.&stringObj.
:c.:xph.'Unowned' | 'Owned':exph.
:row.
:c.owner
:c.Owner
:c.&noneObj. | :xph.<Map&colon.STAF/Service/Sem/MutexOwner>:exph.
:c.
:row.
:c.requestList
:c.Pending Requests
:c.:xph.<List> of <Map&colon.STAF/Service/Sem/PendingRequest>:exph.
:c.
:tnote text='Notes'.
:ol compact.
:li.If the mutex semaphore is currently unowned, "Owner" will be &noneObj..
:li.If the mutex semaphore is currently owned, "Owner" will contain information
about the owner of the semaphore and "Pending Requests" will contain a list
of requests waiting to acquire the mutex, if any.
:eol.
:etnote.
:etable.
:table cols='* * * 2*'.
:tcap.Definition of map class STAF/Service/Sem/MutexOwner
:tnote text='Description'.This map class represents the owner of a mutex semaphore.
:thd.
:c.Key Name
:c.Display Name
:c.Type
:c.Format / Value
:ethd.
:row.
:c.machine
:c.Machine
:c.&stringObj.
:c.
:row.
:c.handleName
:c.handle
:c.&stringObj.
:c.
:row.
:c.handle
:c.Handle
:c.&stringObj.
:c.
:row.
:c.user
:c.User
:c.&stringObj.
:c.:xph.<Authenticator>://<User ID>:exph.
:row.
:c.endpoint
:c.Endpoint
:c.&stringObj.
:c.:xph.<Interface>://<System Identifier>[@<Port>]:exph.
:row.
:c.requestTimestamp
:c.Date-Time Requested
:c.&stringObj.
:c.&timestampFormat.
:row.
:c.acquireTimestamp
:c.Date-Time Acquired
:c.&stringObj.
:c.&timestampFormat.
:etable.
:table cols='* * * 2*'.
:tcap.Definition of map class STAF/Service/Sem/PendingRequest
:tnote text='Description'.This map class represents a pending request which is
waiting to acquire a mutex semaphore.
:thd.
:c.Key Name
:c.Display Name
:c.Type
:c.Format / Value
:ethd.
:row.
:c.machine
:c.Machine
:c.&stringObj.
:c.
:row.
:c.handleName
:c.handle
:c.&stringObj.
:c.
:row.
:c.handle
:c.Handle
:c.&stringObj.
:c.
:row.
:c.user
:c.User
:c.&stringObj.
:c.:xph.<Authenticator>://<User ID>:exph.
:row.
:c.endpoint
:c.Endpoint
:c.&stringObj.
:c.:xph.<Interface>://<System Identifier>[@<Port>]:exph.
:row.
:c.requestTimestamp
:c.Date-Time Requested
:c.&stringObj.
:c.&timestampFormat.
:etable.
:p.
:li.The result buffer for a :xph."QUERY EVENT <Name>":exph. request will
contain a marshalled :xph.<Map&colon.STAF/Service/Sem/QueryEvent>:exph.
representing an event semaphore.
The maps are defined as follows:
:table cols='* * 2* *'.
:tcap.Definition of map class STAF/Service/Sem/QueryEvent
:tnote text='Description'.This map class represents an event semaphore.
:thd.
:c.Key Name
:c.Display Name
:c.Type
:c.Format / Value
:ethd.
:row.
:c.state
:c.State
:c.&stringObj.
:c.:xph.'Posted' | 'Reset':exph.
:row.
:c.lastPosted
:c.Last Posted
:c.:xph.<Map&colon.STAF/Service/Sem/EventRequester>:exph.
:c.
:row.
:c.lastReset
:c.Last Reset
:c.:xph.<Map&colon.STAF/Service/Sem/EventRequester>:exph.
:c.
:row.
:c.waiterList
:c.Waiters
:c.:xph.<List> of <Map&colon.STAF/Service/Sem/EventRequester>:exph.
:c.
:tnote text='Notes'.
If the event semaphore is currently in a reset state, 
"Waiters" will contain a list of requests waiting for the semaphore, if any.
:etnote.
:etable.
:table cols='* * * 2*'.
:tcap.Definition of map class STAF/Service/Sem/EventRequester
:tnote text='Description'.This map class represents a request for a event semaphore.
:thd.
:c.Key Name
:c.Display Name
:c.Type
:c.Format / Value
:ethd.
:row.
:c.machine
:c.Machine
:c.&stringObj.
:c.
:row.
:c.handleName
:c.handle
:c.&stringObj.
:c.
:row.
:c.handle
:c.Handle
:c.&stringObj.
:c.
:row.
:c.user
:c.User
:c.&stringObj.
:c.:xph.<Authenticator>://<User ID>:exph.
:row.
:c.endpoint
:c.Endpoint
:c.&stringObj.
:c.:xph.<Interface>://<System Identifier>[@<Port>]:exph.
:row.
:c.timestamp
:c.Date-Time
:c.&stringObj.
:c.&timestampFormat.
:etable.
:eul.

:h4.Examples
:p.
:ul.
:li.:hp2.Goal::ehp2.&nbsp; Query information about mutex semaphore
DataSource1.  Assume the semaphore is currently unowned.
:p.:hp2.Syntax::ehp2.&nbsp; :xph.QUERY MUTEX DataSource1:exph.
:p.:hp2.Results::ehp2.  If the request is issued from the command line,
the result, in default format, could look like:
:xmp.
State           : Unowned
Owner           : <None>
Pending Requests: []
:exmp.
:p.
:li.:hp2.Goal::ehp2.&nbsp; Query information about mutex semaphore
DataSource1.  Assume the semaphore is currently owned and there are
no pending requests for it.
:p.:hp2.Syntax::ehp2.&nbsp; :xph.QUERY MUTEX DataSource1:exph.
:p.:hp2.Results::ehp2.  If the request is issued from the command line,
the result, in verbose format, could look like:
:xmp.
{
  State           : Owned
  Owner           : {
    Machine            : machine1.austin.ibm.com
    Handle Name        : STAX/Job/1
    Handle             : 17
    User               : none://anonymous
    Endpoint           : tcp://machine1.austin.ibm.com@6500
    Date-Time Requested: 20041026-23:54:41
    Date-Time Acquired : 20041026-23:54:41
  }
  Pending Requests: []
}
:exmp.
:p.
:li.:hp2.Goal::ehp2.&nbsp; Query information about mutex semaphore
DataSource1.  Assume the semaphore is currently owned and there are
2 pending requests for it.
:p.:hp2.Syntax::ehp2.&nbsp; :xph.QUERY MUTEX DataSource1:exph.
:p.:hp2.Results::ehp2.  If the request is issued from the command line,
the result, in verbose format, could look like:
:xmp.
{
  State           : Owned
  Owner           : {
    Machine            : machine1.austin.ibm.com
    Handle Name        : STAX/Job/1
    Handle             : 17
    User               : none://anonymous
    Endpoint           : tcp://machine1.austin.ibm.com@6500
    Date-Time Requested: 20041026-23:54:41
    Date-Time Acquired : 20041026-23:54:41
  }
  Pending Requests: [
    {
      Machine            : machine2.austin.ibm.com
      Handle Name        : STAF/Client
      Handle             : 32
      User               : none://anonymous
      Endpoint           : tcp://machine2.austin.ibm.com@6500
      Date-Time Requested: 20041026-23:56:16
    }
    {
      Machine            : server1.austin.ibm.com
      Handle Name        : semTest
      Handle             : 49
      User               : IBM://[e-mail]
      Endpoint           : tcp://server1.austin.ibm.com@6500
      Date-Time Requested: 20041026-23:56:31
    }
  ]
}
:exmp.
:p.
:li.:hp2.Goal::ehp2.&nbsp; Query information about event semaphore
Server1/LAN_Started.  Assume the semaphore is currently in a posted state.
:p.:hp2.Syntax::ehp2.&nbsp; :xph.QUERY EVENT Server1/LAN_Started:exph.
:p.:hp2.Results::ehp2.  If the request is issued from the command line,
the result, in verbose format, could look like:
:xmp.
{
  State      : Posted
  Last Posted: {
    Machine    : machine1.austin.ibm.com
    Handle Name: STAF/Client
    Handle     : 20
    User       : none://anonymous
    Endpoint   : tcp://machine1.austin.ibm.com@6500
    Date-Time  : 20041026-23:59:51
  }
  Last Reset : {
    Machine    : server2.austin.ibm.com
    Handle Name: myHandle
    Handle     : 17
    User       : IBM://[e-mail]
    Endpoint   : tcp://server2.austin.ibm.com@6500
    Date-Time  : 20041026-23:59:15
  }
  Waiters    : []
}
:exmp.
:p.
:li.:hp2.Goal::ehp2.&nbsp; Query information about event semaphore
Server1/LAN_Started.  Assume the semaphore is currently in a reset state
with 2 waiters.
:p.:hp2.Syntax::ehp2.&nbsp; :xph.QUERY EVENT Server1/LAN_Started:exph.
:p.:hp2.Results::ehp2.  If the request is issued from the command line,
the result, in verbose format, could look like:
:xmp.
{
  State      : Reset
  Last Posted: {
    Machine    : machine1.austin.ibm.com
    Handle Name: STAF/Client
    Handle     : 20
    User       : none://anonymous
    Endpoint   : tcp://machine1.austin.ibm.com@6500
    Date-Time  : 20041026-23:59:51
  }
  Last Reset : {
    Machine    : server2.austin.ibm.com
    Handle Name: myHandle
    Handle     : 17
    User       : IBM://[e-mail]
    Endpoint   : tcp://server2.austin.ibm.com@6500
    Date-Time  : 20041027-00:02:12
  }
  Waiters    : [
    {
      Machine    : server2.austin.ibm.com
      Handle Name: myHandle
      Handle     : 17
      User       : IBM://[e-mail]
      Endpoint   : tcp://server2.austin.ibm.com@6500
      Date-Time  : 20041027-00:02:18
    }
    {
      Machine    : machine1.austin.ibm.com
      Handle Name: STAF/Client
      Handle     : 22
      User       : none://anonymous
      Endpoint   : tcp://machine1.austin.ibm.com@6500
      Date-Time  : 20041027-00:02:15
    }
  ]
}
:exmp.
:eul.

.*
.*---------------------------------------------------------------------
.*
:ih1.service commands
:ih2.LIST
:i3.semaphore service
:h3.LIST
:p.LIST allows you to obtain a list of the mutex or event semaphores.

:h4.Syntax
:xmp.
LIST <MUTEX | EVENT>
:exmp.
:p.:xph.MUTEX:exph. specifies that you want a list of the mutex semaphores.
:p.:xph.EVENT:exph. specifies that you want a list of the event semaphores.

:h4.Security
:p.&seclvl. 2.

:h4.Return Codes
:p.All return codes from LIST are documented in :hdref refid=retcode..

:h4.Results
:p.On successful return, the result buffer will contain a list of the desired
mutex or event semaphores:
:p.
:ul.
:li.The result buffer for a :xph.LIST MUTEX:exph. request will contain a marshalled
:xph.<List> of <Map&colon.STAF/Service/Sem/MutexInfo>:exph.
representing the mutex semaphores.
The map is defined as follows:
:table cols='* * * *'.
:tcap.Definition of map class STAF/Service/Sem/MutexInfo
:tnote text='Description'.This map class represents a mutex semaphore.
:thd.
:c.Key Name
:c.Display Name
:c.Type
:c.Format / Value
:ethd.
:row.
:c.name
:c.Name
:c.&stringObj.
:c.
:row.
:c.state
:c.State
:c.&stringObj.
:c.:xph.'Unowned' | 'Owned':exph.
:row.
:c.pendingRequests
:c.Pending Requests
:c.&stringObj.
:c.
:tnote text='Notes'.
"Pending Requests" is the number of requests waiting to acquire the mutex.
:etnote.
:etable.
:p.
:li.The result buffer for a :xph.LIST EVENT:exph. request will contain
a marshalled :xph.<List> of <Map&colon.STAF/Service/Sem/EventInfo>:exph.
representing the event semaphores.
The map is defined as follows:
:table cols='* * * *'.
:tcap.Definition of map class STAF/Service/Sem/EventInfo
:tnote text='Description'.This map class represents an event semaphore.
:thd.
:c.Key Name
:c.Display Name
:c.Type
:c.Format / Value
:ethd.
:row.
:c.name
:c.Name
:c.&stringObj.
:c.
:row.
:c.state
:c.State
:c.&stringObj.
:c.:xph.'Posted' | 'Reset':exph.
:row.
:c.waiters
:c.Waiters
:c.&stringObj.
:c.
:tnote text='Notes'.
"Waiters" is the number of waiters waiting on the event semaphore.
:etnote.
:etable.
:eul.

:h4.Examples
:p.
:ul.
:li.:hp2.Goal::ehp2.&nbsp; Obtain a list of the of mutex semaphores.
:p.:hp2.Syntax::ehp2.&nbsp; :xph.LIST MUTEX:exph.
:p.:hp2.Results::ehp2.  If the request is issued from the command line,
the result, in table format, could look like:
:xmp.
Name              State   Pending Requests
----------------- ------- ----------------
DataSource1       Unowned 0
Printers/Printer1 Owned   2
:exmp.
:p.
:li.:hp2.Goal::ehp2.&nbsp; Obtain a list of the of event semaphores.
:p.:hp2.Syntax::ehp2.&nbsp; :xph.LIST EVENT:exph.
:p.:hp2.Results::ehp2.  If the request is issued from the command line,
the result, in table format, could look like:
:xmp.
Name                State  Waiters
------------------- ------ -------
Coffee/Ready        Posted 0
Server1/LAN_Started Reset  5
Shutdown_The_Lab    Reset  0
:exmp.
:eul.