OSF DCE Application Development Guide--Core Components

OSF DCE Application Development Guide—Core Components

To change the default collection size, specify

collection size dddd

(where dddd is the collection size you desire) in a separate

line in Part 1 of the sams ﬁle.

code Identiﬁes the message.

sub-component Identiﬁes the subcomponent that will use the message. (This

must also have been deﬁned in Part II of the sams ﬁle.)

attributes Speciﬁes various things about the message: what kind of

message it is, how it is to be routed, and so on. Multiple

attributes are speciﬁed by ORing their values together. In the

example shown, the message has the severity attribute

svc_c_sev_notice, and the routing attribute

svc_c_route_stderr; the latter forces the message to be routed

to stderr whenever it is written by a serviceability routine.

text Speciﬁes the text of the message itself.

explanation Describes the meaning of the message. The text following this

keyword is used to generate the documentation of the

component’s messages.

action Describes any action(s) that should be taken in response to the

message. The text following this keyword is used to generate

the documentation of the component’s messages.

Not all the possible keywords are illustrated in our example, and, of those illustrated,

only code and text are required in all circumstances. In the example, explanation and

action have been speciﬁed because it is simpler at this point to do so than to leave them

out, and attributes and sub-component have been speciﬁed for reasons that will be

made clear later on.

This ﬁnal part of the sams ﬁle also contains a series of one or more records that specify

messages identifying each of the subcomponents themselves. Since our application has

only one subcomponent, it contains only one such subcomponent-identifying message:

# Part IIIa

# Messages for serviceability table

start !intable undocumented

code hel_i_svc_main

text "hello_svc main"

end

The keywords have the same meanings as they did in the ‘‘Hello World’’ message. A

couple of ﬂags have been speciﬁed after the start keyword. The ﬁrst will cause the

message to not be generated in the message table, and the second means that the message

does not need any explanation or action text associated with it. By specifying

undocumented (with intable, to cause the message to actually be generated even though

it was to be undocumented) for the ‘‘Hello’’ message, we could have eliminated the

explanation and action keywords there also.

4− 6 Tandem Computers Incorporated 124245