semi合集-English.pdf - 第1673页

SEMI E39-0703 © SEMI 1995, 2003 15 Parameter Definition Form names that are supported by an object type. ServiceParamete rName Parameter name. Text. ServiceParameterValue Parameter value. Any. Varies depending on the par…

100%1 / 7923
SEMI E39-0703 © SEMI 1995, 2003 14
Parameter Definition Form
ErrorCode Contains the code for the
specific error found.
Enumerated:
Unknown Object in Object Specifier
Unknown Target Object Type
Unknown Object Instance
Unknown Attribute Name
Read-Only Attribute — Access Denied
ErrorText Text in support of the error
code to provide additional
information.
Text.
ObjAck Acknowledgement code. Unsigned integer. Possible values:
Successful completion of request
Error
ObjectAction The name of an action to be
performed on, or by, an object.
Text. Enumerated per individual object.
ObjectAction
Acknowledgement
Status of action request. Enumerated:
Action was performed successfully.
Action does not exist.
Cannot perform now – try later.
Action will be performed and notification sent later.
Action is prohibited.
Target object unknown.
ObjectActionParameter
Request
Structure composed of a name
and a value for a given object
parameter used in the request.
Structure of ServiceParameterName and ServiceParameterValue.
ObjectActionParameter
Result
Structure composed of a name
and a value for given object
parameter used in the result.
Structure of ServiceParameterName and ServiceParameterValue.
ObjectActionReportStatus Status of receipt of an
ObjectActionComplete-
Notification.
Binary.
ObjectActionStatus Result of the action request. Structure of ObjectActionAcknowledgement and Status.
ObjectLinkID Set to non-zero if and only if
additional completion reports
will be sent.
Unsigned integer.
ObjectServiceList Specified the services
supported by a given object
type.
Structure composed of ObjType, ServiceName.
ObjID Object identifier (ObjID). Varies with object type.
ObjSetting Attribute values for an object
instance.
Structure composed of ObjID and (List of) AttrSetting.
ObjSpec The object specifier, used to
specify the owner of the target
object.
Formatted text.
ObjStatus Information concerning the
success or failure of the
operation.
Structure consisting of ObjAck and Status.
ObjType Object type. Object types are text strings reserved by individual standards. Object
Services do not reserve object types.
OperationID Identifies a specific request. Unsigned Integer.
ServiceName The name of a service or action
to be performed on, or by, an
object.
Text.
ServiceParameterDef A structure of a service name
and a list of the
p
arameter
A structure of ServiceName and associated list of
ServiceParameterNames.
SEMI E39-0703 © SEMI 1995, 2003 15
Parameter Definition Form
names that are supported by an
object type.
ServiceParameterName Parameter name. Text.
ServiceParameterValue Parameter value. Any. Varies depending on the parameter.
Status Error information. (List of) Structure composed of ErrorCode and ErrorText.
11.5 Get and Set Attributes — The GetAttr and SetAttr
services are provided for reading and setting values of
an object' s attributes. They address attribute values of
instances of objects. Figures 7 and 8 show the message
flow for the GetAttr service.
Figure 7
GetAttr Message Flow
Figure 8
SetAttr Message Flow
11.5.1 GetAttr and SetAttr allow access to attributes of
objects that are owned by another object and are
capable of addressing multiple levels of ownership
(object hierarchy).
11.5.1.1 For example, GetAttr may be used as a “get
directory” request to find the identifiers of all instances
of one or more owned objects.
11.5.2 GetAttr and SetAttr may be used for objects that
use a complex identifier, such as recipes with separate
attributes for name and version.
11.5.3 GetAttr and SetAttr allow searching for those
instances of an object that satisfy certain conditions
through the specification of one or more qualifiers or
filters. Only attributes of those instances of the desired
object type that satisfy the conditions defined in the
filters are returned by the service provider.
11.5.3.1 The filter is familiar to users of file services as
a convenient way to obtain a partial directory of files,
such as files with a date later than a specified date. This
is particularly useful when the list of contents may be
quite long.
11.5.4 The attribute value (all or a part of the list of
ObjSetting) returned by the GetAttr service may be
invalid if the acknowledge code of ObjStatus indicates
a failure. In that case; the value(s) requested by the
invocation of GetAttr service may be unknown, invalid
or unavailable by any reason (e.g. corresponding
hardware status, lack of privilege, mutual exclusion or
other requirement not fulfilled by the application).
Supplier shall document all conditions or timing
requirements of any attributes if they are not always
available.
11.5.5 The attribute value (all or a part of the list of
ObjSetting) replied by the SetAttr service may be still
unchanged if the acknowledge code of ObjStatus
indicates a failure. In that case; the attribute value may
be unchangeable, inhibited or blocked internally by any
reason (e.g. corresponding hardware status, lack of
privilege, mutual exclusion or other requirement not
fulfilled by the application. The object providing the
SetAttr service shall identify whether or not it is valid
to change or set an attribute value. Supplier shall
document all conditions and timing requirements of
each attribute if they are not always allowed to be set.
11.5.6 Object Specifier — This parameter is used for
specifying an owner object and may be omitted from
the message. When included, it is a formatted text
string that conforms to the description in Section 9. An
object specifier is rejected by service providers that do
not use owner or owned objects.
11.5.7 Filter — This is a optional list of qualifications
to be applied to specifed attribute and may be omitted
from the message. When included, the complete filter is
formed by a logical AND of each attribute qualification
in the list.
11.5.8 Requested Attribute — The final parameter in
the GetAttr service gives the names of one or more
attributes of interest. These are the attributes whose
values shall be returned in the response, in the order
requested.
11.5.9 Settings — In the SetAttr service, a list of one or
more attribute name/value pairs is specified. This is the
set of desired attribute values. SetAttr rejects any
attempt to set a read-only attribute and returns
SEMI E39-0703 © SEMI 1995, 2003 16
information in Status, indicating the error and the
attribute.
11.5.10 ObjStatus — This is a required parameter in
the response message. It is a structure that consists of
an acknowledge code and a list of status parameters.
The acknowledge code is used to indicate errors that
apply to the response as a whole. A status parameter is
a structure consisting of a code indicating a specific
error and accompanying text providing additional
information. Text is often used to inform a person of
the results of an operation.
11.5.11 Tables 4 and 5 define the parameters for the
GetAttr and SetAttr services, respectively.
Table 4 GetAttr Service
Parameter Req/Ind Rsp/Conf Description
ObjSpec C - The object specifier, used to specify the owner of the target object.
ObjType M - The type of the target object.
(List of)
ObjID
C - The identifier of the target object. If present, identifiers are treated as a pre-filter
of the form “ObjID = <identifier>”, where the individual identifiers are joined
with logical OR’s.
(List of)
AttrFilter
C - An attribute filter to be applied to the target object. If both AttrFilter and ObjID
are omitted, attributes are requested for all instances of the target object type.
(List of)
AttrName
C - The name of a desired attribute. If the name is “ObjType,” and if ObjType
(above) is omitted, then the object type of all subordinate objects is requested.
If omitted, then all public attributes of the target object are requested.
(List of)
ObjSetting
- M Attributes that match the specified characteristics, per qualifying object
instance. Setting value may not be valid if corresponding ObjStatus shows a
failure.
ObjStatus - M Information concerning the success or failure of the request.
Table 5 SetAttr Service
Parameter Req/Ind Rsp/Conf Description
ObjSpec C - The object specifier, used to specify the owner of the target object.
ObjType M - The type of the target object.
(List of)
ObjID
C - The identifier of the target object. If present, is treated as a primary filter of the
form “ObjID = <identifier>”.
(List of)
AttrSetting
M - An attribute’s name and desired value.
(List of)
ObjSetting
- M The attributes’ resulting values. Requested setting value(s) may have not
changed if corresponding ObjStatus shows a failure.
ObjStatus - M Information concerning the success or failure of the request.
11.6 GetType — GetType is a service that is directed at object types rather than object instances. It is used to ask an
owner object for the object types that it owns.
11.6.1 Figure 9 shows the message flow for the GetType service.
Figure 9
GetType Message Flow